1		% (c) 2009-2024 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(translate,
6		[print_bexpr_or_subst/1, l_print_bexpr_or_subst/1,
7		print_bexpr/1, debug_print_bexpr/1,
8		nested_print_bexpr/1, nested_print_bexpr_as_classicalb/1,
9		print_bexpr_stream/2,
10		print_components/1,
11		print_bexpr_with_limit/2, print_bexpr_with_limit_and_typing/3,
12		print_unwrapped_bexpr_with_limit/1,print_bvalue/1, l_print_bvalue/1, print_bvalue_stream/2,
13		translate_params_for_dot/2, translate_params_for_dot_nl/2,
14		print_machine/1,
15		translate_machine/3,
16		set_unicode_mode/0, unset_unicode_mode/0, unicode_mode/0,
17		unicode_translation/2, % unicode translation of a symbol/keyword
18		set_latex_mode/0, unset_latex_mode/0, latex_mode/0,
19		set_atelierb_mode/1, unset_atelierb_mode/0,
20		set_force_eventb_mode/0, unset_force_eventb_mode/0,
21		get_translation_mode/1, set_translation_mode/1, unset_translation_mode/1,
22		with_translation_mode/2,
23		get_language_mode/1, set_language_mode/1, with_language_mode/2,
24		translate_bexpression_to_unicode/2,
25		translate_bexpression/2, translate_subst_or_bexpr_in_mode/3,
26		translate_bexpression_with_limit/3, translate_bexpression_with_limit/2,
27		translate_bexpression_to_codes/2,
28		translate_bexpr_to_parseable/2,
29		translate_predicate_into_machine/3, nested_print_sequent_as_classicalb/6,
30		get_bexpression_column_template/4,
31		translate_subst_or_bexpr/2, translate_subst_or_bexpr_with_limit/3,
32		translate_substitution/2, print_subst/1,
33		translate_bvalue/2, translate_bvalue_to_codes/2, translate_bvalue_to_codes_with_limit/3,
34		translate_bvalue_to_parseable_classicalb/2,
35		translate_bvalue_for_dot/2,
36		translate_bvalue_with_limit/3,
37		translate_bvalue_with_type/3, translate_bvalue_with_type_and_limit/4,
38		translate_bvalue_for_expression/3, translate_bvalue_for_expression_with_limit/4,
39		translate_bvalue_with_tlatype/3,
40		translate_bvalue_kind/2,
41		print_state/1,
42		translate_bstate/2, translate_bstate_limited/2, translate_bstate_limited/3,
43		print_bstate/1, print_bstate_limited/3,
44		translate_b_state_to_comma_list/3,
45		translate_context/2, print_context/1,
46		translate_any_state/2,
47		print_value_variable/1,
48		print_cspm_state/1, translate_cspm_state/2,
49		print_csp_value/1, translate_csp_value/2,
50		translate_cspm_expression/2,
51		translate_properties_with_limit/2,
52		translate_event/2,translate_events/2,
53		translate_event_with_target_id/4,
54		translate_event_with_src_and_target_id/4, translate_event_with_src_and_target_id/5,
55		get_non_det_modified_vars_in_target_id/3,
56		translate_event_with_limit/3,
57		translate_state_errors/2,translate_state_error/2,
58		translate_event_error/2,
59		translate_call_stack/2,
60		translate_prolog_constructor/2, translate_prolog_constructor_in_mode/2,
61		get_texpr_top_level_symbol/4,
62		pretty_type/2, % pretty-prints a type (pp_type, translate_type)
63		explain_state_error/3, get_state_error_span/2,
64		explain_event_trace/3,
65		generate_typing_predicates/2, % keeps sequence typing info
66
67		print_raw_machine_terms/1,
68		print_raw_bexpr/1, l_print_raw_bexpr/1,
69		translate_raw_bexpr_with_limit/3,
70
71		print_span/1, print_span_nl/1, translate_span/2,
72		translate_span_with_filename/2,
73		get_definition_context_from_span/2,
74
75		%set_type_to_maximal_texpr/2, type_set/2, % now in typing_tools as create_type_set
76
77		translate_error_term/2, translate_error_term/3,
78		translate_prolog_exception/2,
79
80		set_translation_constants/1, set_translation_context/1,
81		clear_translation_constants/0,
82
83		set_print_type_infos/1,
84		set_print_type_infos/2, reset_print_type_infos/1,
85		suppress_rodin_positions/1, reset_suppress_rodin_positions/1,
86		add_normal_typing_predicates/3,
87
88		install_b_portray_hook/0,remove_b_portray_hook/0,
89
90		translate_eventb_to_classicalb/3,
91		translate_eventb_direct_definition_header/3, translate_eventb_direct_definition_body/2,
92		return_csp_closure_value/2,
93		latex_to_unicode/2, get_latex_keywords/1, get_latex_keywords_with_backslash/1,
94		ascii_to_unicode/2
95
96		]).
97
98		:- meta_predicate call_pp_with_no_limit_and_parseable(0).
99		:- meta_predicate with_translation_mode(+, 0).
100		:- meta_predicate with_language_mode(+, 0).
101
102		:- use_module(tools).
103		:- use_module(tools_lists,[is_list_simple/1]).
104		:- use_module(extrasrc(json_parser), [json_write_stream/1]).
105
106		:- use_module(module_information).
107		:- module_info(group,tools).
108		:- module_info(description,'This module is responsible for pretty-printing B and CSP, source spans, ...').
109
110		:- use_module(library(lists)).
111		:- use_module(library(codesio)).
112		:- use_module(library(terms)).
113		:- use_module(library(avl)).
114
115		:- use_module(debug).
116		:- use_module(error_manager).
117		:- use_module(self_check).
118		:- use_module(b_global_sets).
119		:- use_module(specfile,[csp_with_bz_mode/0,process_algebra_mode/0,
120		animation_minor_mode/1,set_animation_minor_mode/1,
121		remove_animation_minor_mode/0,
122		animation_mode/1,set_animation_mode/1, csp_mode/0,
123		translate_operation_name/2]).
124		:- use_module(bsyntaxtree).
125		%:- use_module('smv/smv_trans',[smv_print_initialisation/2]).
126		:- use_module(preferences,[get_preference/2, set_preference/2, eclipse_preference/2]).
127		:- use_module(bmachine_structure).
128		:- use_module(avl_tools,[check_is_non_empty_avl/1]).
129
130		:- set_prolog_flag(double_quotes, codes).
131
132		% print a list of expressions or substitutions
133		l_print_bexpr_or_subst([]).
134		l_print_bexpr_or_subst([H|T]) :-
135		print_bexpr_or_subst(H),
136		(T=[] -> true
137		; (get_texpr_type(H,Type),is_subst_type(Type) -> print('; ') ; print(', '),
138		l_print_bexpr_or_subst(T))
139		).
140
141		is_subst_type(T) :- var(T),!,fail.
142		is_subst_type(subst).
143		is_subst_type(op(_,_)).
144
145		print_bexpr_or_subst(E) :- get_texpr_type(E,T),is_subst_type(T),!, print_subst(E).
146		print_bexpr_or_subst(precondition(A,B)) :- !, print_subst(precondition(A,B)).
147		print_bexpr_or_subst(any(A,B,C)) :- !, print_subst(any(A,B,C)).
148		print_bexpr_or_subst(select(A)) :- !, print_subst(select(A)). % TO DO: add more cases ?
149		print_bexpr_or_subst(E) :- print_bexpr(E).
150
151		print_unwrapped_bexpr_with_limit(Expr) :- print_unwrapped_bexpr_with_limit(Expr,200).
152		print_unwrapped_bexpr_with_limit(Expr,Limit) :-
153		translate:print_bexpr_with_limit(b(Expr,pred,[]),Limit),nl.
154		debug_print_bexpr(E) :- debug:debug_mode(off) -> true ; print_bexpr(E).
155		print_bexpr(Expr) :- translate_bexpression(Expr,R), write(R).
156		print_bexpr_with_limit(Expr,Limit) :- translate_bexpression_with_limit(Expr,Limit,R), write(R).
157		print_bvalue(Val) :- translate_bvalue(Val,TV), write(TV).
158		print_bexpr_stream(S,Expr) :- translate_bexpression(Expr,R), write(S,R).
159		print_bvalue_stream(S,Val) :- translate_bvalue(Val,R), write(S,R).
160
161		print_bexpr_with_limit_and_typing(Expr,Limit,TypeInfos) :-
162		set_print_type_infos(TypeInfos,CHNG),
163		(get_texpr_type(Expr,pred)
164		-> find_typed_identifier_uses(Expr, TUsedIds),
165		add_typing_predicates(TUsedIds,Expr,Expr2)
166		; Expr2=Expr),
167		call_cleanup(print_bexpr_with_limit(Expr2,Limit),
168		reset_print_type_infos(CHNG)).
169
170		print_components(C) :- print_components(C,0).
171		print_components([],Nr) :- write('Nr of components: '),write(Nr),nl.
172		print_components([component(Pred,Vars)|T],Nr) :- N1 is Nr+1,
173		write('Component: '), write(N1), write(' over '), write(Vars),nl,
174		print_bexpr(Pred),nl,
175		print_components(T,N1).
176
177		l_print_bvalue([]).
178		l_print_bvalue([H|T]) :- print_bvalue(H), write(' : '),l_print_bvalue(T).
179
180		nested_print_bexpr_as_classicalb(E) :- nested_print_bexpr_as_classicalb2(E,0).
181
182		nested_print_bexpr_as_classicalb2(E,InitialPeanoIndent) :-
183		(animation_minor_mode(X)
184		-> remove_animation_minor_mode,
185		call_cleanup(nested_print_bexpr2(E,InitialPeanoIndent), set_animation_minor_mode(X))
186		; nested_print_bexpr2(E,InitialPeanoIndent)).
187
188		% can also print lists of predicates and lists of lists, ...
189		nested_print_bexpr(Expr) :- nested_print_bexpr2(Expr,0).
190
191		% a version where one can specify the initial indent in peano numbering
192		nested_print_bexpr2([],_) :- !.
193		nested_print_bexpr2([H],InitialIndent) :- !,nested_print_bexpr2(H,InitialIndent).
194		nested_print_bexpr2([H|T],II) :- !,
195		nested_print_bexpr2(H,II),
196		print_indent(II), write('&'),nl,
197		nested_print_bexpr2(T,II).
198		nested_print_bexpr2(Expr,II) :- nbp(Expr,conjunct,II).
199
200		nbp(b(E,_,Info),Type,Indent) :- !,nbp2(E,Type,Info,Indent).
201		nbp(E,Type,Indent) :- format(user_error,'Missing b/3 wrapper!~n',[]),
202		nbp2(E,Type,[],Indent).
203		nbp2(E,Type,_Info,Indent) :- get_binary_connective(E,NewType,Ascii,LHS,RHS),!,
204		inc_indent(NewType,Type,Indent,NIndent),
205		print_bracket(Indent,NIndent,'('),
206		nbp(LHS,NewType,NIndent),
207		print_indent(NIndent),
208		translate_in_mode(NewType,Ascii,Symbol), print(Symbol),nl,
209		(is_associative(NewType) -> NewTypeR=NewType % no need for parentheses if same operator on right
210		; NewTypeR=right(NewType)),
211		nbp(RHS,NewTypeR,NIndent),
212		print_bracket(Indent,NIndent,')').
213		nbp2(lazy_let_pred(TID,LHS,RHS),Type,_Info,Indent) :-
214		def_get_texpr_id(TID,ID),!,
215		NewType=lazy_let_pred(TID),
216		inc_indent(NewType,Type,Indent,NIndent),
217		print_indent(Indent), format('LET ~w = (~n',[ID]),
218		nbp(LHS,NewType,NIndent),
219		print_indent(NIndent), print(') IN ('),nl,
220		nbp(RHS,NewType,NIndent),
221		print_indent(NIndent),print(')'),nl.
222		nbp2(negation(LHS),_Type,_Info,Indent) :- !,
223		inc_indent(negation,false,Indent,NIndent),
224		print_indent(Indent),
225		translate_in_mode(negation,'not',Symbol), format('~s(~n',[Symbol]),
226		nbp(LHS,negation,NIndent),
227		print_indent(Indent), print(')'),nl.
228		nbp2(let_predicate(Ids,Exprs,Pred),_Type,_Info,Indent) :- !,
229		inc_indent(let_predicate,false,Indent,NIndent),
230		pp_expr_ids_in_mode(Ids,_LR,Codes,[]),
231		print_indent(Indent),format('#~s.( /* LET */~n',[Codes]),
232		pp_expr_let_pred_exprs(Ids,Exprs,_LimitReached,Codes2,[]),
233		print_indent(Indent), format('~s~n',[Codes2]),
234		print_indent(NIndent), print('&'),nl,
235		nbp(Pred,let_predicate,NIndent),
236		print_indent(Indent), print(')'),nl.
237		nbp2(exists(Ids,Pred),_Type,_Infos,Indent) :- !,
238		inc_indent(exists,false,Indent,NIndent),
239		pp_expr_ids_in_mode(Ids,_LR,Codes,[]),
240		print_indent(Indent),
241		%(member(allow_to_lift_exists,_Infos) -> write('/* LIFT */ ') ; true),
242		exists_symbol(ExistsSymbol,[]), format('~s~s.(~n',[ExistsSymbol,Codes]),
243		nbp(Pred,exists,NIndent),
244		print_indent(Indent), print(')'),nl.
245		nbp2(forall(Ids,LHS,RHS),_Type,_Info,Indent) :- !,
246		inc_indent(forall,false,Indent,NIndent),
247		pp_expr_ids_in_mode(Ids,_LR,Codes,[]),
248		print_indent(Indent),
249		forall_symbol(ForallSymbol,[]), format('~s~s.(~n',[ForallSymbol,Codes]),
250		nbp(LHS,forall,NIndent),
251		print_indent(NIndent),
252		translate_in_mode(implication,'=>',Symbol),print(Symbol),nl,
253		nbp(RHS,forall,NIndent),
254		print_indent(Indent), print(')'),nl.
255		nbp2(if_then_else(Test,LHS,RHS),_Type,_Info,Indent) :- !,
256		inc_indent(if_then_else,false,Indent,NIndent),
257		print_indent(Indent), print('IF'),nl,
258		nbp(Test,if_then_else,NIndent),
259		print_indent(Indent), print('THEN'),nl,
260		nbp(LHS,if_then_else,NIndent),
261		print_indent(Indent), print('ELSE'),nl,
262		nbp(RHS,if_then_else,NIndent),
263		print_indent(Indent), print('END'),nl.
264		%nbp2(equal(LHS,RHS),pred,_Info,Indent) :-
265		% get_texpr_id(LHS,_Id),!,
266		% print_indent(Indent),print_bexpr(LHS),print(' ='),nl,
267		% inc_indent(equal,false,Indent,NIndent),
268		nbp2(value(V),_,Info,Indent) :- !,
269		print_indent(Indent), print_bexpr(b(value(V),any,Info)),nl.
270		nbp2(E,_,Info,Indent) :- print_indent(Indent), print_bexpr(b(E,pred,Info)),nl.
271
272		% all left-associative
273		get_binary_connective(conjunct(LHS,RHS),conjunct,'&',LHS,RHS).
274		get_binary_connective(disjunct(LHS,RHS),disjunct,'or',LHS,RHS).
275		get_binary_connective(implication(LHS,RHS),implication,'=>',LHS,RHS).
276		get_binary_connective(equivalence(LHS,RHS),equivalence,'<=>',LHS,RHS).
277
278		inc_indent(Type,CurType,I,NewI) :- (Type=CurType -> NewI=I ; NewI=s(I)).
279		print_bracket(I,I,_) :- !.
280		print_bracket(I,_NewI,Bracket) :-
281		print_indent(I), print(Bracket),nl.
282
283		print_indent(s(X)):- !,
284		print(' '),
285		print_indent(X).
286		print_indent(_).
287
288
289		/* =============================================== */
290		/* Translating expressions and values into strings */
291		/* =============================================== */
292
293		translate_params_for_dot(List,TransList) :-
294		translate_params_for_dot(List,TransList,3,-3).
295		translate_params_for_dot_nl(List,TransList) :- % newline after every entry
296		translate_params_for_dot(List,TransList,1,-1).
297
298		translate_params_for_dot([],'',_,_).
299		translate_params_for_dot([H|T],Res,Lim,Nr) :-
300		translate_property_with_limit(H,100,TH),
301		(Nr>=Lim -> N1=1 % Limit reached, add newline
302		; N1 is Nr+1),
303		translate_params_for_dot(T,TT,Lim,N1),
304		string_concatenate(TH,TT,Res1),
305		(N1=1
306		-> string_concatenate(',\n',Res1,Res)
307		; (Nr>(-Lim) -> string_concatenate(',',Res1,Res)
308		; Res=Res1)).
309
310
311		translate_channel_values(X,['_'|T],T) :- var(X),!.
312		translate_channel_values([],S,S) :- !.
313		translate_channel_values([tuple([])|T],S,R) :- !,
314		translate_channel_values(T,S,R).
315		translate_channel_values([in(tuple([]))|T],S,R) :- !,
316		translate_channel_values(T,S,R).
317		translate_channel_values([H|T],['.'|S],R) :- !,
318		((nonvar(H),H=in(X))
319		-> Y=X
320		; Y=H
321		),
322		pp_csp_value(Y,S,S2),
323		translate_channel_values(T,S2,R).
324		translate_channel_values(tail_in(X),S,T) :-
325		(X=[] ; X=[_|_]), !, translate_channel_values(X,S,T).
326		translate_channel_values(_X,['??'|S],S).
327
328
329
330		pp_single_csp_value(V,'_') :- var(V),!.
331		pp_single_csp_value(X,'_cyclic_') :- cyclic_term(X),!.
332		pp_single_csp_value(int(X),A) :- atomic(X),!,number_chars(X,Chars),atom_chars(A,Chars).
333
334		:- assert_must_succeed((translate_cspm_expression(listExp(rangeOpen(2)),R), R == '<2..>')).
335		:- assert_must_succeed((translate_cspm_expression(listFrom(2),R), R == '<2..>')).
336		:- assert_must_succeed((translate_cspm_expression(listFromTo(2,6),R), R == '<2..6>')).
337		:- assert_must_succeed((translate_cspm_expression(setFromTo(2,6),R), R == '{2..6}')).
338		:- assert_must_succeed((translate_cspm_expression('#'(listFromTo(2,6)),R), R == '#<2..6>')).
339		:- assert_must_succeed((translate_cspm_expression(inGuard(x,setFromTo(1,5)),R), R == '?x:{1..5}')).
340		:- assert_must_succeed((translate_cspm_expression(builtin_call(int(3)),R), R == '3')).
341		:- assert_must_succeed((translate_cspm_expression(set_to_seq(setValue([int(1),int(2)])),R), R == 'seq({1,2})')).
342		:- assert_must_succeed((translate_cspm_expression(diff(setValue([int(1)]),setValue([])),R), R == 'diff({1},{})')).
343		:- assert_must_succeed((translate_cspm_expression(inter(setValue([int(1)]),setValue([])),R), R == 'inter({1},{})')).
344		:- assert_must_succeed((translate_cspm_expression(lambda([x,y],'*'(x,y)),R), R == '\\ x,y @ (x*y)')).
345		:- assert_must_succeed((translate_cspm_expression(lambda([x,y],'/'(x,y)),R), R == '\\ x,y @ (x/y)')).
346		:- assert_must_succeed((translate_cspm_expression(lambda([x,y],'%'(x,y)),R), R == '\\ x,y @ (x%y)')).
347		:- assert_must_succeed((translate_cspm_expression(rename(x,y),R), R == 'x <- y')).
348		:- assert_must_succeed((translate_cspm_expression(link(x,y),R), R == 'x <-> y')).
349		:- assert_must_succeed((translate_cspm_expression(agent_call_curry(f,[[a,b],[c]]),R), R == 'f(a,b)(c)')).
350
351		translate_cspm_expression(Expr, Text) :-
352		(pp_csp_value(Expr,Atoms,[]) -> ajoin(Atoms,Text)
353		; print('Pretty printing expression failed: '),print(Expr),nl).
354
355		pp_csp_value(X,[A|S],S) :- pp_single_csp_value(X,A),!.
356		pp_csp_value(setValue(L),['{'|S],T) :- !,pp_csp_value_l(L,',',S,['}'|T],inf).
357		pp_csp_value(setExp(rangeEnum(L)),['{'|S],T) :- !,pp_csp_value_l(L,',',S,['}'|T],inf).
358		pp_csp_value(setExp(rangeEnum(L),Gen),['{'|S],T) :- !,
359		copy_term((L,Gen),(L2,Gen2)), numbervars((L2,Gen2),1,_),
360		pp_csp_value_l(L2,',',S,['|'|S2],inf),
361		pp_csp_value_l(Gen2,',',S2,['}'|T],inf).
362		pp_csp_value(avl_set(A),['{'|S],T) :- !, check_is_non_empty_avl(A),
363		avl_domain(A,L),pp_csp_value_l(L,',',S,['}'|T],inf).
364		pp_csp_value(setExp(rangeClosed(L,U)),['{'|S],T) :- !, pp_csp_value(L,S,['..'|S2]),pp_csp_value(U,S2,['}'|T]).
365		pp_csp_value(setExp(rangeOpen(L)),['{'|S],T) :- !, pp_csp_value(L,S,['..}'|T]).
366		% TO DO: pretty print comprehensionGuard; see prints in coz-example.csp ; test 1846
367		pp_csp_value(comprehensionGenerator(Var,Body),S,T) :- !, pp_csp_value(Var,S,['<-'|S1]),
368		pp_csp_value(Body,S1,T).
369		pp_csp_value(listExp(rangeEnum(L)),['<'|S],T) :- !,pp_csp_value_l(L,',',S,['>'|T],inf).
370		pp_csp_value(listExp(rangeClosed(L,U)),['<'|S],T) :- !, pp_csp_value(L,S,['..'|S2]),pp_csp_value(U,S2,['>'|T]).
371		pp_csp_value(listExp(rangeOpen(L)),['<'|S],T) :- !, pp_csp_value(L,S,['..>'|T]).
372		pp_csp_value(setFromTo(L,U),['{'|S],T) :- !,
373		pp_csp_value(L,S,['..'|S2]),pp_csp_value(U,S2,['}'|T]).
374		pp_csp_value(setFrom(L),['{'|S],T) :- !,
375		pp_csp_value(L,S,['..}'|T]).
376		pp_csp_value(closure(L), ['{|'|S],T) :- !,pp_csp_value_l(L,',',S,['|}'|T],inf).
377		pp_csp_value(list(L),['<'|S],T) :- !,pp_csp_value_l(L,',',S,['>'|T],inf).
378		pp_csp_value(listFromTo(L,U),['<'|S],T) :- !,
379		pp_csp_value(L,S,['..'|S2]),pp_csp_value(U,S2,['>'|T]).
380		pp_csp_value(listFrom(L),['<'|S],T) :- !,
381		pp_csp_value(L,S,['..>'|T]).
382		pp_csp_value('#'(L),['#'|S],T) :- !,pp_csp_value(L,S,T).
383		pp_csp_value('^'(X,Y),S,T) :- !,pp_csp_value(X,S,['^'|S1]), pp_csp_value(Y,S1,T).
384		pp_csp_value(linkList(L),S,T) :- !,pp_csp_value_l(L,',',S,T,inf).
385		pp_csp_value(in(X),['?'|S],T) :- !,pp_csp_value(X,S,T).
386		pp_csp_value(inGuard(X,Set),['?'|S],T) :- !,pp_csp_value(X,S,[':'|S1]),
387		pp_csp_value(Set,S1,T).
388		pp_csp_value(out(X),['!'|S],T) :- !,pp_csp_value(X,S,T).
389		pp_csp_value(alsoPat(X,_Y),S,T) :- !,pp_csp_value(X,S,T).
390		pp_csp_value(appendPat(X,_Fun),S,T) :- !,pp_csp_value(X,S,T).
391		pp_csp_value(tuple(vclosure),S,T) :- !, S=T.
392		pp_csp_value(tuple([X]),S,T) :- !,pp_csp_value_in(X,S,T).
393		pp_csp_value(tuple([X|vclosure]),S,T) :- !,pp_csp_value_in(X,S,T).
394		pp_csp_value(tuple([H|TT]),S,T) :- !,pp_csp_value_in(H,S,['.'|S1]),pp_csp_value(tuple(TT),S1,T).
395		pp_csp_value(dotTuple([]),['unit_channel'|S],S) :- ! .
396		pp_csp_value(dotTuple([H]),S,T) :- !, pp_csp_value_in(H,S,T).
397		pp_csp_value(dotTuple([H|TT]),S,T) :- !, pp_csp_value_in(H,S,['.'|S1]),
398		pp_csp_value(dotTuple(TT),S1,T).
399		pp_csp_value(tupleExp(Args),S,T) :- !,pp_csp_args(Args,S,T,'(',')').
400		pp_csp_value(na_tuple(Args),S,T) :- !,pp_csp_args(Args,S,T,'(',')').
401		pp_csp_value(record(Name,Args),['('|S],T) :- !,pp_csp_value(tuple([Name|Args]),S,[')'|T]).
402		pp_csp_value(val_of(Name,_Span),S,T) :- !, pp_csp_value(Name,S,T).
403		pp_csp_value(builtin_call(X),S,T) :- !,pp_csp_value(X,S,T).
404		pp_csp_value(seq_to_set(X),['set('|S],T) :- !,pp_csp_value(X,S,[')'|T]).
405		pp_csp_value(set_to_seq(X),['seq('|S],T) :- !,pp_csp_value(X,S,[')'|T]).
406		%pp_csp_value('\\'(B,C,S),S1,T) :- !, pp_csp_process(ehide(B,C,S),S1,T).
407		pp_csp_value(agent_call(_Span,Agent,Parameters),['('|S],T) :- !,
408		pp_csp_value(Agent,S,S1),
409		pp_csp_args(Parameters,S1,[')'|T],'(',')').
410		pp_csp_value(agent_call_curry(Agent,Parameters),S,T) :- !,
411		pp_csp_value(Agent,S,S1),
412		pp_csp_curry_args(Parameters,S1,T).
413		pp_csp_value(lambda(Parameters,Body),['\\ '|S],T) :- !,
414		pp_csp_args(Parameters,S,[' @ '|S1],'',''),
415		pp_csp_value(Body,S1,T).
416		pp_csp_value(rename(X,Y),S,T) :- !,pp_csp_value(X,S,[' <- '|S1]),
417		pp_csp_value(Y,S1,T).
418		pp_csp_value(link(X,Y),S,T) :- !,pp_csp_value(X,S,[' <-> '|S1]),
419		pp_csp_value(Y,S1,T).
420		% binary operators:
421		pp_csp_value(Expr,['('|S],T) :- bynary_numeric_operation(Expr,E1,E2,OP),!,
422		pp_csp_value(E1,S,[OP|S2]),
423		pp_csp_value(E2,S2,[')'|T]).
424		% built-in functions for sets
425		pp_csp_value(empty(A),[empty,'('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
426		pp_csp_value(card(A),[card,'('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
427		pp_csp_value('Set'(A),['Set','('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
428		pp_csp_value('Inter'(A1),['Inter','('|S],T) :- !,pp_csp_value(A1,S,[')'|T]).
429		pp_csp_value('Union'(A1),['Union','('|S],T) :- !,pp_csp_value(A1,S,[')'|T]).
430		pp_csp_value(diff(A1,A2),[diff,'('|S],T) :- !,pp_csp_args([A1,A2],S,[')'|T],'','').
431		pp_csp_value(inter(A1,A2),[inter,'('|S],T) :- !,pp_csp_args([A1,A2],S,[')'|T],'','').
432		pp_csp_value(union(A1,A2),[union,'('|S],T) :- !,pp_csp_args([A1,A2],S,[')'|T],'','').
433		pp_csp_value(member(A1,A2),[member,'('|S],T) :- !,pp_csp_args([A1,A2],S,[')'|T],'','').
434		% built-in functions for sequences
435		pp_csp_value(null(A),[null,'('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
436		pp_csp_value(length(A),[length,'('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
437		pp_csp_value(head(A),[head,'('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
438		pp_csp_value(tail(A),[tail,'('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
439		pp_csp_value(elem(A1,A2),[elem,'('|S],T) :- !,pp_csp_args([A1,A2],S,[')'|T],'','').
440		pp_csp_value(concat(A1,A2),[concat,'('|S],T) :- !,pp_csp_args([A1,A2],S,[')'|T],'','').
441		pp_csp_value('Seq'(A),['Seq','('|S],T) :- !, pp_csp_value(A,S,[')'|T]).
442		% vclosure
443		pp_csp_value(Expr,S,T) :- is_list(Expr),!,pp_csp_value(closure(Expr),S,T).
444		% Type expressions
445		pp_csp_value(dotTupleType([H]),S,T) :- !, pp_csp_value_in(H,S,T).
446		pp_csp_value(dotTupleType([H|TT]),S,T) :- !,pp_csp_value_in(H,S,['.'|S1]), pp_csp_value(dotTupleType(TT),S1,T).
447		pp_csp_value(typeTuple(Args),S,T) :- !, pp_csp_args(Args,S,T,'(',')').
448		pp_csp_value(dataType(T),[T|S],S) :- ! .
449		pp_csp_value(boolType,['Bool'|S],S) :- ! .
450		pp_csp_value(intType,['Int'|S],S) :- ! .
451		pp_csp_value(dataTypeDef([H]),S,T) :- !, pp_csp_value(H,S,T).
452		pp_csp_value(dataTypeDef([H|TT]),S,T) :- !, pp_csp_value(H,S,['|'|S1]),
453		pp_csp_value(dataTypeDef(TT),S1,T).
454		pp_csp_value(constructor(Name),[Name|S],S) :- ! .
455		pp_csp_value(constructorC(C,Type),[C,'('|S],T) :- !, pp_csp_value(Type,S,[')'|T]).
456		% Argument of function can be process
457
458		pp_csp_value(Expr,S,T) :- pp_csp_process(Expr,S,T),!. % pp_csp_process has a catch-all !!! TO DO: look at this
459		pp_csp_value(Expr,S,T) :- csp_with_bz_mode,!,pp_value(Expr,S,T).
460		pp_csp_value(X, [A|S], S) :- % ['<< ',A,' >>'|S],S) :- % the << >> pose problems when checking against FDR
461		write_to_codes(X,Codes),atom_codes_with_limit(A,Codes).
462
463		pp_csp_value_in(H,S,T) :- nonvar(H),H=in(X),!, pp_csp_value(X,S,T).
464		pp_csp_value_in(H,S,T) :- pp_csp_value(H,S,T).
465
466		print_csp_value(Val) :- pp_csp_value(Val,Atoms,[]), ajoin(Atoms,Text),
467		print(Text).
468
469		translate_csp_value(Val,Text) :- pp_csp_value(Val,Atoms,[]), ajoin(Atoms,Text).
470
471		return_csp_closure_value(closure(S),List) :- pp_csp_value_l1(S,List).
472		return_csp_closure_value(setValue(S),List) :- pp_csp_value_l1(S,List).
473
474		pp_csp_value_l1([Expr|Rest],List) :-
475		( nonvar(Rest),Rest=[] ->
476		pp_csp_value(Expr,T,[]),ajoin(T,Value),List=[Value]
477		; pp_csp_value_l1(Rest,R),pp_csp_value(Expr,T,[]),ajoin(T,Value),List=[Value|R]
478		).
479
480		pp_csp_args([],T,T,_LPar,_RPar).
481		pp_csp_args([H|TT],[LPar|S],T,LPar,RPar) :- pp_csp_value(H,S,S1), pp_csp_args2(TT,S1,T,RPar).
482		pp_csp_args2([],[RPar|T],T,RPar).
483		pp_csp_args2([H|TT],[','|S],T,RPar) :- pp_csp_value(H,S,S1), pp_csp_args2(TT,S1,T,RPar).
484
485		pp_csp_curry_args([],T,T).
486		pp_csp_curry_args([H|TT],S,T) :- is_list(H), pp_csp_args(H,S,S1,'(',')'), pp_csp_curry_args(TT,S1,T).
487
488		pp_csp_value_l(V,_Sep,['...'|S],S,N) :- (var(V) ; (N \= inf -> N<1;fail)), !.
489		pp_csp_value_l([],_Sep,S,S,_).
490		pp_csp_value_l([Expr|Rest],Sep,S,T,Nr) :-
491		( nonvar(Rest),Rest=[] ->
492		pp_csp_value(Expr,S,T)
493		;
494		(Nr=inf -> N1 = Nr ; N1 is Nr-1),
495		pp_csp_value(Expr,S,[Sep|S1]),pp_csp_value_l(Rest,Sep,S1,T,N1)).
496
497		:- assert_must_succeed((translate:convert_set_into_sequence([(int(1),int(5))],Seq),
498		check_eqeq(Seq,[int(5)]))).
499		:- assert_must_succeed((translate:convert_set_into_sequence([(int(2),X),(int(1),int(5))],Seq),
500		check_eq(Seq,[int(5),X]))).
501
502		convert_set_into_sequence(Set,Seq) :-
503		nonvar(Set), \+ eventb_translation_mode,
504		convert_set_into_sequence1(Set,Seq).
505		convert_set_into_sequence1(avl_set(A),Seq) :- !, check_is_non_empty_avl(A),
506		avl_size(A,Sz),size_is_in_set_limit(Sz),convert_avlset_into_sequence(A,Seq).
507		convert_set_into_sequence1([],Seq) :- !, Seq=[].
508		convert_set_into_sequence1(Set,Seq) :-
509		convert_set_into_sequence2(Set,0,_,SetElems,Seq),ground(SetElems).
510		convert_set_into_sequence2([],_Max,([],[]),_,_Seq).
511		convert_set_into_sequence2([Pair|T],Max,Last,SetElems,Seq) :-
512		nonvar(Pair),nonvar(T),Pair=(Index,H),ground(Index),
513		Index=int(Nr),
514		insert_el_into_seq(Nr,H,Seq,SetElems,L),
515		(Nr>Max -> NMax=Nr,NLast=L ; NMax=Max,NLast=Last),
516		convert_set_into_sequence2(T,NMax,NLast,SetElems,Seq).
517		insert_el_into_seq(1,H,[H|L],[set|L2],(L,L2)) :- !.
518		insert_el_into_seq(N,H,[_|T],[_|T2],Last) :- N>1, N1 is N-1, insert_el_into_seq(N1,H,T,T2,Last).
519
520		convert_avlset_into_sequence(Avl,Sequence) :-
521		\+ eventb_translation_mode,
522		convert_avlset_into_sequence2(Avl,1,Sequence).
523		convert_avlset_into_sequence2(Avl,_Index,[]) :-
524		empty_avl(Avl),!.
525		convert_avlset_into_sequence2(Avl,Index,[Head|Tail]) :-
526		avl_del_min(Avl, Min, _ ,NewAvl),
527		nonvar(Min), Min=(L,Head),
528		ground(L), L=int(Index),
529		Index2 is Index + 1,
530		convert_avlset_into_sequence2(NewAvl,Index2,Tail).
531
532		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
533		% translate new syntax tree -- work in progress
534		:- assert_must_succeed((translate_cspm_state(lambda([x,y],'|~|'(prefix(_,[],x,skip(_),_),prefix(_,[],y,skip(_),_),_)),R), R == 'CSP: \\ x,y @ (x->SKIP) |~| (y->SKIP)')).
535		:- assert_must_succeed((translate_cspm_state(agent_call_curry('F',[[a,b],[c]]),R), R == 'CSP: F(a,b)(c)')).
536		:- assert_must_succeed((translate_cspm_state(ifte(bool_not('<'(x,3)),';'(esharing([a],'/\\'('P1','P2',span),procRenaming([rename(r,s)],'Q',span),span),lParallel([link(b,c)],'R','S',span),span),'[>'(elinkParallel([link(h1,h2)],'G1','G2',span),exception([a],'H1','H2',span),span),span1,span2,span3),R), R == 'CSP: if not((x<3)) then ((P1) /\\ (P2) [|{|a|}|] Q[[r <- s]]) ; (R [{|b <-> c|}] S) else (G1 [{|h1 <-> h2|}] G2) [> (H1 [|{|a|}|> H2)')).
537		:- assert_must_succeed((translate_cspm_state(aParallel([a,b],'P',[b,c],'Q',span),R), R == 'CSP: P [{|a,b|} || {|b,c|}] Q')).
538		:- assert_must_succeed((translate_cspm_state(eaParallel([a,b],'P',[b,c],'Q',span),R), R == 'CSP: P [{|a,b|} || {|b,c|}] Q')).
539		:- assert_must_succeed((translate_cspm_state(eexception([a,b],'P','Q',span),R), R == 'CSP: P [|{|a,b|}|> Q')).
540
541		print_cspm_state(State) :- translate_cspm_state(State,T), print(T).
542
543		translate_cspm_state(State,Text) :-
544		( pp_csp_process(State,Atoms,[]) -> true
545		; print(pp_csp_process_failed(State)),nl,Atoms=State),
546		ajoin(['CSP: '|Atoms],Text).
547
548		pp_csp_process(skip(_Span),S,T) :- !, S=['SKIP'|T].
549		pp_csp_process(stop(_Span),S,T) :- !, S=['STOP'|T].
550		pp_csp_process('CHAOS'(_Span,Set),['CHAOS('|S],T) :- !,
551		pp_csp_value(Set,S,[')'|T]).
552		pp_csp_process(val_of(Agent,_Span),S,T) :- !,
553		pp_csp_value(Agent,S,T).
554		pp_csp_process(builtin_call(X),S,T) :- !,pp_csp_process(X,S,T).
555		pp_csp_process(agent(F,Body,_Span),S,T) :- !,
556		F =.. [Agent|Parameters],
557		pp_csp_value(Agent,S,S1),
558		pp_csp_args(Parameters,S1,[' = '|S2],'(',')'),
559		pp_csp_value(Body,S2,T).
560		pp_csp_process(agent_call(_Span,Agent,Parameters),S,T) :- !,
561		pp_csp_value(Agent,S,S1),
562		pp_csp_args(Parameters,S1,T,'(',')').
563		pp_csp_process(agent_call_curry(Agent,Parameters),S,T) :- !,
564		pp_csp_value(Agent,S,S1),
565		pp_csp_curry_args(Parameters,S1,T).
566		pp_csp_process(lambda(Parameters,Body),['\\ '|S],T) :- !,
567		pp_csp_args(Parameters,S,[' @ '|S1],'',''),
568		pp_csp_value(Body,S1,T).
569		pp_csp_process('\\'(B,C,S),S1,T) :- !, pp_csp_process(ehide(B,C,S),S1,T).
570		pp_csp_process(ehide(Body,ChList,_Span),['('|S],T) :- !,
571		pp_csp_process(Body,S,[')\\('|S1]),
572		pp_csp_value(ChList,S1,[')'|T]).
573		pp_csp_process(let(Decls,P),['let '| S],T) :- !,
574		maplist(translate_cspm_state,Decls,Texts),
575		ajoin_with_sep(Texts,' ',Text),
576		S=[Text,' within '|S1],
577		pp_csp_process(P,S1,T).
578		pp_csp_process(Expr,['('|S],T) :- binary_csp_op(Expr,X,Y,Op),!,
579		pp_csp_process(X,S,[') ',Op,' ('|S1]),
580		pp_csp_process(Y,S1,[')'|T]).
581		pp_csp_process(Expr,S,T) :- sharing_csp_op(Expr,X,Middle,Y,Op1,Op2),!,
582		pp_csp_process(X,S,[Op1|S1]),
583		pp_csp_value(Middle,S1,[Op2|S2]),
584		pp_csp_process(Y,S2,T).
585		pp_csp_process(Expr,S,T) :- asharing_csp_op(Expr,X,MiddleX,MiddleY,Y,Op1,MOp,Op2),!,
586		pp_csp_process(X,S,[Op1|S1]),
587		pp_csp_value(MiddleX,S1,[MOp|S2]),
588		pp_csp_value(MiddleY,S2,[Op2|S3]),
589		pp_csp_process(Y,S3,T).
590		pp_csp_process(Expr,S,T) :- renaming_csp_op(Expr,X,RList,Op1,Op2),!,
591		pp_csp_process(X,S,[Op1|S1]),
592		pp_csp_value_l(RList,',',S1,[Op2|T],10).
593		pp_csp_process(prefix(_SPAN1,Values,ChannelExpr,CSP,_SPAN2),S,T) :- !,
594		pp_csp_value_l([ChannelExpr|Values],'',S,['->'|S2],20),
595		pp_csp_process(CSP,S2,T).
596		pp_csp_process('&'(Test,Then),S,T) :- !,
597		pp_csp_bool_expr(Test,S,['&'|S2]),
598		pp_csp_process(Then,S2,T).
599		pp_csp_process(ifte(Test,Then,Else,_SPAN1,_SPAN2,_SPAN3),[' if '|S],T) :- !,
600		pp_csp_bool_expr(Test,S,[' then '|S2]),
601		pp_csp_process(Then,S2,[' else '|S3]),
602		pp_csp_process(Else,S3,T).
603		pp_csp_process(head(A),[head,'('|S],T) :- !, pp_csp_process(A,S,[')'|T]).
604		pp_csp_process(X,[X|T],T).
605
606		pp_csp_bool_expr(bool_not(BE),['not('|S],T) :- !, pp_csp_bool_expr(BE,S,[')'|T]).
607		pp_csp_bool_expr(BE,['('|S],T) :- binary_bool_op(BE,BE1,BE2,OP), !,
608		pp_csp_bool_expr(BE1,S,[OP|S2]),
609		pp_csp_bool_expr(BE2,S2,[')'|T]).
610		pp_csp_bool_expr(BE,[OP,'('|S],T) :- binary_pred(BE,BE1,BE2,OP), !,
611		pp_csp_value(BE1,S,[','|S2]),
612		pp_csp_value(BE2,S2,[')'|T]).
613		pp_csp_bool_expr(BE,S,T) :- pp_csp_value(BE,S,T).
614
615		bynary_numeric_operation('+'(X,Y),X,Y,'+').
616		bynary_numeric_operation('-'(X,Y),X,Y,'-').
617		bynary_numeric_operation('*'(X,Y),X,Y,'*').
618		bynary_numeric_operation('/'(X,Y),X,Y,'/').
619		bynary_numeric_operation('%'(X,Y),X,Y,'%').
620
621		binary_pred('member'(X,Y),X,Y,member).
622		binary_pred('<'(X,Y),X,Y,'<').
623		binary_pred('>'(X,Y),X,Y,'>').
624		binary_pred('>='(X,Y),X,Y,'>=').
625		binary_pred('<='(X,Y),X,Y,'=<').
626		binary_pred('elem'(X,Y),X,Y,is_elem_list).
627		binary_pred('=='(X,Y),X,Y,equal_element).
628		binary_pred('!='(X,Y),X,Y,not_equal_element).
629
630
631		binary_bool_op('<'(X,Y),X,Y,'<').
632		binary_bool_op('>'(X,Y),X,Y,'>').
633		binary_bool_op('>='(X,Y),X,Y,'>=').
634		binary_bool_op('<='(X,Y),X,Y,'=<').
635		binary_bool_op('=='(X,Y),X,Y,'==').
636		binary_bool_op('!='(X,Y),X,Y,'!=').
637		binary_bool_op(bool_and(X,Y),X,Y,'&&').
638		binary_bool_op(bool_or(X,Y),X,Y,'||').
639
640		binary_csp_op('|||'(X,Y,_Span),X,Y,'|||').
641		binary_csp_op('[]'(X,Y,_Span),X,Y,'[]').
642		binary_csp_op('|~|'(X,Y,_Span),X,Y,'|~|').
643		binary_csp_op(';'(X,Y,_Span),X,Y,';').
644		binary_csp_op('[>'(P,Q,_SrcSpan),P,Q,'[>').
645		binary_csp_op('/\\'(P,Q,_SrcSpan),P,Q,'/\\').
646
647		sharing_csp_op(esharing(CList,X,Y,_SrcSpan),X,CList,Y,' [|','|] ').
648		sharing_csp_op(sharing(CList,X,Y,_SrcSpan),X,CList,Y,' [|','|] ').
649		sharing_csp_op(lParallel(LinkList,X,Y,_Span),X,LinkList,Y,' [','] ').
650		sharing_csp_op(elinkParallel(LinkList,X,Y,_Span),X,LinkList,Y,' [','] ').
651		sharing_csp_op(exception(CList,X,Y,_SrcSpan),X,CList,Y,' [|','|> ').
652		sharing_csp_op(eexception(CList,X,Y,_SrcSpan),X,CList,Y,' [|','|> ').
653
654		asharing_csp_op(aParallel(CListX,X,CListY,Y,_SrcSpan),X,CListX,CListY,Y,' [',' || ','] ').
655		asharing_csp_op(eaParallel(CListX,X,CListY,Y,_SrcSpan),X,CListX,CListY,Y,' [',' || ','] ').
656
657		renaming_csp_op(procRenaming(RenameList,X,_SrcSpan),X,RenameList,'[[',']]').
658		renaming_csp_op(eprocRenaming(RenameList,X,_SrcSpan),X,RenameList,'[[',']]').
659
660		:- use_module(bmachine,[b_get_machine_operation_parameter_types/2, b_is_operation_name/1]).
661
662		translate_events([],[]).
663		translate_events([E|Erest],[Out|Orest]) :-
664		translate_event(E,Out),
665		translate_events(Erest,Orest).
666
667
668		% a version of translate_event which has access to the target state id:
669		% this allows to translate setup_constants, intialise by inserting target constants or values
670
671		translate_event_with_target_id(Term,Dst,Limit,Str) :-
672		translate_event_with_src_and_target_id(Term,unknown,Dst,Limit,Str).
673		translate_event_with_src_and_target_id(Term,Src,Dst,Str) :-
674		translate_event_with_src_and_target_id(Term,Src,Dst,5000,Str).
675
676		translate_event_with_src_and_target_id(Term,Src,Dst,Limit,Str) :-
677		get_preference(expand_avl_upto,CurLim),
678		SetLim is Limit//2,% at least two symbols per element
679		(CurLim<0 ; SetLim < CurLim),!,
680		temporary_set_preference(expand_avl_upto,SetLim,CHNG),
681		call_cleanup(translate_event_with_target_id2(Term,Src,Dst,Limit,Str),
682		reset_temporary_preference(expand_avl_upto,CHNG)).
683		translate_event_with_src_and_target_id(Term,Src,Dst,Limit,Str) :-
684		translate_event_with_target_id2(Term,Src,Dst,Limit,Str).
685
686		setup_cst_functor('$setup_constants',"SETUP_CONSTANTS").
687		setup_cst_functor('$partial_setup_constants',"PARTIAL_SETUP_CONSTANTS").
688
689		translate_event_with_target_id2(Term,_,Dst,Limit,Str) :-
690		functor(Term,Functor,_),
691		setup_cst_functor(Functor,UI_Name),
692		get_preference(show_initialisation_arguments,true),
693		state_space:visited_expression(Dst,concrete_constants(State)),
694		get_non_det_constant(State,NonDetState),
695		!,
696		translate_b_state_to_comma_list_codes(UI_Name,NonDetState,Limit,Codes),
697		atom_codes_with_limit(Str,Limit,Codes).
698		translate_event_with_target_id2(Term,_,Dst,Limit,Str) :-
699		functor(Term,'$initialise_machine',_),
700		get_preference(show_initialisation_arguments,true),
701	?	bmachine:b_get_operation_non_det_modifies('$initialise_machine',NDModVars),
702		state_space:visited_expression(Dst,State), get_variables(State,VarsState),
703		(NDModVars \= []
704		->
705		include(non_det_modified_var(NDModVars),VarsState,ModVarsState) % first show non-det variables
706		% we could add a preference for whether to show the deterministicly assigned variables at all
707		%exclude(non_det_modified_var(NDModVars),VarsState,ModVarsState2),
708		%append(ModVarsState1,ModVarsState2,ModVarsState)
709		; ModVarsState = VarsState),
710		!,
711		translate_b_state_to_comma_list_codes("INITIALISATION",ModVarsState,Limit,Codes),
712		atom_codes_with_limit(Str,Limit,Codes).
713		translate_event_with_target_id2(Term,Src,Dst,Limit,Str) :-
714		atomic(Term), % only applied to operations without parameters
715	?	specfile:b_mode,
716		get_non_det_modified_vars_in_target_id(Term,Dst,ModVarsState0), % only show non-det variables
717		(Src \= unknown,
718		state_space:visited_expression(Src,SrcState), get_variables(SrcState,PriorVarsState)
719		-> exclude(var_not_really_modified(PriorVarsState),ModVarsState0,ModVarsState)
720		% we could also optionally filter out vars which have the same value for all outgoing transitions of Src
721		; ModVarsState = ModVarsState0
722		),
723		!,
724		atom_codes(Term,TermCodes),
725		translate_b_state_to_comma_list_codes(TermCodes,ModVarsState,Limit,Codes),
726		atom_codes_with_limit(Str,Limit,Codes).
727		translate_event_with_target_id2(Term,_,_,Limit,Str) :- translate_event_with_limit(Term,Limit,Str).
728
729
730		get_non_det_modified_vars_in_target_id(OpName,DstId,ModVarsState0) :-
731		bmachine:b_get_operation_non_det_modifies(OpName,NDModVars),
732		NDModVars \= [], % a variable is non-deterministically written
733		state_space:visited_expression(DstId,State), % TO DO: unpack only NModVars
734		get_variables(State,VarsState),
735		include(non_det_modified_var(NDModVars),VarsState,ModVarsState0).
736
737		:- use_module(library(ordsets)).
738		non_det_modified_var(NDModVars,bind(Var,_)) :- ord_member(Var,NDModVars).
739
740		var_not_really_modified(PriorState,bind(Var,Val)) :-
741	?	(member(bind(Var,PVal),PriorState) -> PVal=Val).
742
743		get_variables(const_and_vars(_,VarsState),S) :- !, S=VarsState.
744		get_variables(S,S).
745
746		:- dynamic non_det_constants/2.
747
748		% compute which constants are non-deterministically assigned and which ones not
749		% TODO: maybe move to state space and invalidate info in case execute operation by predicate used
750		get_non_det_constant(Template,Result) :- non_det_constants(A,B),!, (A,B)=(Template,Result).
751		get_non_det_constant(Template,Result) :-
752	?	state_space:transition(root,_,DstID),
753		state_space:visited_expression(DstID,concrete_constants(State)), %print(get_non_det_constant(DstID)),nl,
754		!,
755		findall(D,(state_space:transition(root,_,D),D \= DstID),OtherDst),
756		compute_non_det_constants2(OtherDst,State),
757		non_det_constants(Template,Result).
758		get_non_det_constant(A,A).
759
760		compute_non_det_constants2([],State) :- adapt_state(State,Template,Result),
761		(Result = [] -> assertz(non_det_constants(A,A)) % in case all variables are deterministic: just show them
762		; assertz(non_det_constants(Template,Result))).
763		compute_non_det_constants2([Dst|T],State) :-
764		state_space:visited_expression(Dst,concrete_constants(State2)),
765		lub_state(State,State2,NewState),
766		compute_non_det_constants2(T,NewState).
767
768		lub_state([],[],[]).
769		lub_state([bind(V,H1)|T1],[bind(V,H2)|T2],[bind(V,H3)|T3]) :-
770		(H1==H2 -> H3=H1 ; H3='$NONDET'), lub_state(T1,T2,T3).
771
772		adapt_state([],[],[]).
773		adapt_state([bind(ID,Val)|T],[bind(ID,X)|TX],[bind(ID,X)|TY]) :- Val='$NONDET',!,
774		adapt_state(T,TX,TY).
775		adapt_state([bind(ID,_)|T],[bind(ID,_)|TX],TY) :- % Value is deterministic: do not copy
776		adapt_state(T,TX,TY).
777
778
779
780		% ------------------------------------
781
782		translate_event_with_limit(Event,Limit,Out) :-
783		translate_event2(Event,Atoms,[]),!,
784		ajoin_with_limit(Atoms,Limit,Out).
785		%,print(done),debug:print_debug_stats,nl.% , print(Out),nl.
786		translate_event_with_limit(Event,_,Out) :- add_error(translate_event_with_limit,'Could not translate event: ', Event),
787		Out = '???'.
788
789		translate_event(Event,Out) :- %print(translate),print_debug_stats,nl,
790		translate_event2(Event,Atoms,[]),!,
791		ajoin(Atoms,Out).
792		%,print(done),debug:print_debug_stats,nl.% , print(Out),nl.
793		translate_event(Event,Out) :-
794		add_error(translate_event,'Could not translate event: ', Event),
795		Out = '???'.
796		/* BEGIN CSP */
797		translate_event2(start_cspm(Process),['start_cspm('|S],T) :- process_algebra_mode,!,pp_csp_value(Process,S,[')'|T]).
798		%% translate_event2(i(_Span),['i'|T],T) :- process_algebra_mode,!. /* CSP */ %% deprecated
799		translate_event2(tick(_Span),['tick'|T],T) :- process_algebra_mode,!. /* CSP */
800		translate_event2(tau(hide(Action)),['tau(hide('|S],T) :- process_algebra_mode,nonvar(Action), !,
801		translate_event2(Action,S,['))'|T]). /* CSP */
802		translate_event2(tau(link(Action1,Action2)),['tau(link('|S],T) :- /* CSP */
803		nonvar(Action1), nonvar(Action2), process_algebra_mode, !,
804		translate_event2(Action1,S,['<->'|S1]),
805		translate_event2(Action2,S1,['))'|T]).
806		translate_event2(tau(Info),['tau(',Fun,')'|T],T) :-
807		nonvar(Info), process_algebra_mode,!, /* CSP */
808		functor(Info,Fun,_). %(translate_event(Info,Fun) -> true ; functor(Info,Fun,_)),
809		translate_event2(io(V,Ch,_Span),S,T) :- process_algebra_mode,!, /* CSP */
810		(specfile:csp_with_bz_mode ->
811		S=['CSP:'|S1],
812		translate_event2(io(V,Ch),S1,T)
813		;
814		translate_event2(io(V,Ch),S,T)
815		).
816		translate_event2(io(X,Channel),S,T) :- process_algebra_mode,!, /* CSP */
817		(X=[] -> translate_event2(Channel,S,T)
818		; (translate_event2(Channel,S,S1),
819		translate_channel_values(X,S1,T))
820		).
821		/* END CSP */
822		translate_event2('$JUMP'(Name),[A|T],T) :- write_to_codes(Name,Codes),
823		atom_codes_with_limit(A,Codes).
824		translate_event2('-->'(Operation,ResultValues),S,T) :- nonvar(ResultValues),
825		ResultValues=[_|_],!,
826		translate_event2(Operation,S,['-->',ValuesStr|T]),
827		translate_bvalues(ResultValues,ValuesStr).
828		translate_event2(Op,S,T) :-
829		nonvar(Op), Op =.. [OpName|Args],
830		translate_b_operation_call(OpName,Args,S,T),!.
831		translate_event2(Op,[A|T],T) :-
832		%['<< ',A,' >>'|T],T) :- % the << >> pose problems when checking against FDR
833		write_to_codes(Op,Codes),
834		atom_codes_with_limit(A,Codes).
835
836		% translate a B operation call to list of atoms in dcg style
837		translate_b_operation_call(OpName,Args,[TOpName|S],T) :-
838		translate_operation_name(OpName,TOpName),
839		( Args=[] -> S=T
840		;
841		S=['(',ValuesStr,')'|T],
842		( get_preference(show_eventb_any_arguments,false), % otherwise we have additional ANY parameters !
843		\+ is_init(OpName), % order of variables does not always correspond to Variable order used by b_get_machine_operation_parameter_types ! TO DO - Fix this in b_initialise_machine2 (see Interlocking.mch CSP||B model)
844	?	specfile:b_mode,
845		b_is_operation_name(OpName),
846	?	b_get_machine_operation_parameter_types(OpName,ParTypes),
847		ParTypes \= []
848		-> translate_bvalues_with_types(Args,ParTypes,ValuesStr)
849		%; is_init(OpName) -> b_get_machine_operation_typed_parameters(OpName,TypedParas),
850		; translate_bvalues(Args,ValuesStr))
851		).
852
853		% -----------------
854
855		% translate call stacks as stored in wait flag info fields
856		% (managed by push_wait_flag_call_stack_info)
857
858		translate_call_stack(Stack,Msg) :-
859		Opts = [detailed],
860		split_calls(Stack,DStack),
861		get_cs_avl_limit(ALimit),
862		temporary_set_preference(expand_avl_upto,ALimit,CHNG),
863		set_unicode_mode,
864		call_cleanup(render_call_stack(DStack,1,Opts,A,[]),
865		(unset_unicode_mode,
866		reset_temporary_preference(expand_avl_upto,CHNG))),
867		ajoin(['call stack: '|A],Msg).
868		render_call_stack([],_,_) --> [].
869		render_call_stack([H],Nr,Opts) --> !,
870		render_nr(Nr,H,_,Opts), render_call(H,Opts).
871		render_call_stack([H|T],Nr,Opts) -->
872		render_nr(Nr,H,Nr1,Opts),
873		render_call(H,Opts),
874		render_seperator(Opts),
875		render_call_stack(T,Nr1,Opts).
876
877		% render nr of call in call stack
878		render_nr(Pos,H,Pos1,Opts) --> {member(detailed,Opts)},!, ['\n '], render_pos_nr(Pos,H,Pos1).
879		render_nr(Pos,_,Pos,_) --> [].
880
881		render_pos_nr(Pos,definition_call(_,_),Pos) --> !,
882		[' ']. % definition calls are virtual and can appear multiple times for different entries in the call stack
883		% see e.g., public_examples/B/FeatureChecks/DEFINITIONS/DefCallStackDisplay2.mch
884		render_pos_nr(Pos,_,Pos1) --> [Pos] , {Pos1 is Pos+1}, [': '].
885
886		render_seperator(Opts) --> {member(detailed,Opts)},!. % we put newlines in render_nr
887		render_seperator(_Opts) -->
888		{call_stack_arrow_atom_symbol(Symbol)}, [Symbol].
889
890		render_call(definition_call(Name,Pos),Opts) --> !,
891		['within DEFINITION call '],[Name],
892		render_span(Pos,Opts).
893		render_call(operation_call(Op,Paras,Pos),Opts) --> !,
894		translate_b_operation_call(Op,Paras), % TODO: limit size?
895		render_span(Pos,Opts).
896		render_call(using_state(Name,State),_Opts) --> !,
897		[Name], [' with state: '],
898		{get_cs_limit(Limit),translate_bstate_limited(State,Limit,Str)},
899		[Str].
900		render_call(after_event(OpTerm),_Opts) --> !,
901		['after event: '],
902		{get_cs_limit(Limit),translate_event_with_limit(OpTerm,Limit,Str)},
903		[Str].
904		render_call(function_call(Fun,Paras,Pos),Opts) --> !,
905		render_function_call(Fun,Paras),
906		render_span(Pos,Opts).
907		render_call(b_operator_call(OP,Paras,Pos),Opts) --> !,
908		render_operator_arg(b_operator(OP,Paras)),
909		render_span(Pos,Opts).
910		render_call(id_equality_evaluation(ID,Kind,Pos),Opts) --> !,
911		['equality for '],[Kind],[' '],[ID],
912		render_span(Pos,Opts).
913		render_call(b_operator_arg_evaluation(OP,PosNr,Args,Pos),Opts) --> !,
914		['arg '],[PosNr],[' of '],
915		render_operator_arg(b_operator(OP,Args)),
916		render_span(Pos,Opts).
917		render_call(external_call(Name,Paras,Pos),Opts) --> !,
918		['external call '], [Name],['('],
919		{get_cs_limit(Limit),translate_bvalues_with_limit(Paras,Limit,PS)},[PS], [')'],
920		render_span(Pos,Opts).
921		render_call(prob_command_context(Name,Pos),Opts) --> !,
922		['checking '], render_prob_command(Name),
923		render_span(Pos,Opts).
924		render_call(quantifier_call(comprehension_set,ParaNames,ParaValues,Pos),Opts) --> % special case for lambda
925		{nth1(LPos,ParaNames,LambdaRes,RestParaNames),
926		is_lambda_result_name(LambdaRes,_),
927		nth1(LPos,ParaValues,LambdaVal,RestParaValues)},!, % we have found '_lambda_res_' amongst paras
928		render_quantifier(lambda), ['('],
929		render_paras(RestParaNames,RestParaValues),
930		['|'], render_para_val(LambdaVal),
931		[')'],
932		render_span(Pos,Opts).
933		render_call(quantifier_call(Kind,ParaNames,ParaValues,Pos),Opts) --> !,
934		render_quantifier(Kind), ['('],
935		render_paras(ParaNames,ParaValues), [')'],
936		render_span(Pos,Opts).
937		render_call(top_level_call(SpanPred),Opts) -->
938		render_call(SpanPred,Opts).
939		render_call(b_expr_call(Context,Expr),Opts) --> !,
940		[Context],[': '],
941		render_b_expr(Expr),
942		render_span(Expr,Opts).
943		render_call(span_predicate(Pred,LS,S),Opts) --> % Pred can also be an expression like function/2
944		% infos could contain was(extended_expr(Op)); special case for: assertion_expression
945		{Pred=b(_,_,Pos),
946		b_compiler:b_compile(Pred,[],LS,S,CPred,no_wf_available) % inline actual parameters
947		},
948		!,
949		render_b_expr(CPred),
950		render_function_name(Pred), % try show function name from uncompiled Expr
951		render_span(Pos,Opts).
952		render_call(Other,_) --> [Other].
953
954		%render_operator(OP) -->
955		% {(unicode_translation(OP,Unicode) -> FOP=Unicode ; FOP=OP)}, [FOP].
956
957		% render b operator arguments/calls:
958		render_operator_arg(Var) --> {var(Var)},!,['_VARIABLE_']. % should not happen
959		render_operator_arg(b_operator(OP,[Arg1,Arg2])) -->
960		{binary_infix_in_mode(OP,Symbol,_,_)},!,
961		{(unicode_translation(OP,Unicode) -> FOP=Unicode ; FOP=Symbol)}, %TODO: add parentheses if necessary
962		render_operator_arg(Arg1),
963		[' '],[FOP], [' '],
964		render_operator_arg(Arg2).
965		render_operator_arg(b_operator(OP,Args)) --> !,
966		{(unicode_translation(OP,Unicode) -> FOP=Unicode ; function_like(OP,FOP) -> true ; FOP=OP)},
967		[FOP], ['('],
968		render_operator_args(Args),
969		[')'].
970		render_operator_arg(bind(Name,Value)) --> !,
971		[Name], ['='],
972		render_operator_arg(Value).
973		render_operator_arg(identifier(ID)) --> !, [ID].
974		render_operator_arg(Val) --> render_para_val(Val).
975
976		render_operator_args([]) --> !, [].
977		render_operator_args([H]) --> !, render_operator_arg(H).
978		render_operator_args([H|T]) --> !, render_operator_arg(H), [','], render_operator_args(T).
979		render_operator_args(A) --> {add_internal_error('Not a list: ',A)}, ['???'].
980
981		render_prob_command(check_pred_command(PredKind,Arg)) --> !, ['predicate '], render_pred_nr(Arg), ['of '],[PredKind].
982		render_prob_command(eval_expr_command(Kind,Arg)) --> !, ['expression '], render_pred_nr(Arg), ['of '],[Kind].
983		render_prob_command(trace_replay(OpName,FromId)) --> !, ['Trace replay predicate for '],[OpName], [' from '],[FromId].
984		render_prob_command(Cmd) --> [Cmd].
985
986		render_pred_nr(0) --> !. % 0 is special value to indicate we have no number/id within outer kind
987		render_pred_nr(Nr) --> {number(Nr)},!,['# '],[Nr],[' '].
988		render_pred_nr('') --> !.
989		render_pred_nr(AtomId) --> ['for '], [AtomId],[' '].
990
991		render_function_name(b(function(Fun,_),_,_)) --> {try_get_identifier(Fun,FID)},!,
992		% TODO: other means of extracting name; maybe we should render anything that is not a value?
993		['\n (Function applied: '], [FID], [')'].
994		render_function_name(b(_,_,Infos)) --> {member(was(extended_expr(OpID)),Infos)},!,
995		['\n (Theory operator applied: '], [OpID], [')'].
996		render_function_name(_) --> [].
997
998		try_get_identifier(Expr,Id) :- (get_texpr_id(Expr,Id) -> true ; get_was_identifier(Expr,Id)).
999
1000		render_span(Span,Opts) --> {member(detailed,Opts),translate_span(Span,Atom), Atom \= ''},!,
1001		['\n '], [Atom],
1002		({member(additional_descr,Opts),translate_additional_description(Span,Descr)}
1003		-> [' within ',Descr]
1004		; []).
1005		render_span(_,_) --> [].
1006
1007		render_function_call(Fun,Paras) -->
1008		{(atomic(Fun) -> FS=Fun ; translate_bexpr_for_call_stack(Fun,FS))}, % memoization will only register atomic name
1009		[FS],['('], render_para_val(Paras), [')'].
1010
1011		render_b_expr(b(function(Fun,Paras),_,_)) --> !, % ensure we print both function and paras at least partially
1012		{translate_bexpr_for_call_stack(Fun,FS)}, [FS],['('],
1013		{translate_bexpr_for_call_stack(Paras,PS)},[PS], [')'].
1014		render_b_expr(b(assertion_expression(Pred,Msg,b(value(_),string,_)),_,_)) --> !,
1015		% Body is not source of error; probably better to use special call stack entry for assertion_expression
1016		['ASSERT '],[Msg],['\n '],
1017		{translate_bexpr_for_call_stack(Pred,PS)}, [PS].
1018		render_b_expr(CPred) --> {translate_bexpr_for_call_stack(CPred,PS)}, [PS].
1019
1020		translate_bexpr_for_call_stack(Expr,TS) :-
1021		get_cs_limit(Limit),
1022		translate_bexpression_with_limit(Expr,Limit,TS).
1023
1024		get_cs_limit(2000) :- !.
1025		get_cs_limit(Limit) :- debug_mode(on),!, debug_level(Level), % 19 regular, 5 very verbose
1026		Limit is 1000 - Level*20.
1027		get_cs_limit(200) :- get_preference(provide_trace_information,true),!.
1028		get_cs_limit(100).
1029
1030		get_cs_avl_limit(40) :- debug_mode(on),!.
1031		get_cs_avl_limit(6) :- get_preference(provide_trace_information,true),!.
1032		get_cs_avl_limit(4).
1033
1034		get_call_stack_span(operation_call(_,_,Pos),Pos).
1035		%get_call_stack_span(after_event(_),unknown).
1036		get_call_stack_span(function_call(_,_,Pos),Pos).
1037		get_call_stack_span(id_equality_evaluation(_ID,_Kind,Pos),Pos).
1038		get_call_stack_span(quantifier_call(_,_,_,Pos),Pos).
1039		get_call_stack_span(definition_call(_,Pos),Pos).
1040		get_call_stack_span(external_call(_,_,Pos),Pos).
1041		get_call_stack_span(prob_command_context(_,Pos),Pos).
1042		get_call_stack_span(top_level_call(Pos),Pos).
1043		get_call_stack_span(b_operator_call(_,_,Pos),Pos).
1044		get_call_stack_span(b_operator_arg_evaluation(_,_,_,Pos),Pos).
1045		get_call_stack_span(b_expr_call(_,Expr),Expr).
1046		get_call_stack_span(span_predicate(A,B,C),span_predicate(A,B,C)).
1047
1048		nop_call(top_level_call(X)) :- \+ is_top_level_function_call(X).
1049		% just there to insert virtual DEFINITION calls at top-level of call-stack
1050		is_top_level_function_call(span_predicate(b(Expr,_,_),_,_)) :-
1051		Expr = function(_,_),
1052		get_preference(provide_trace_information,false).
1053		% otherwise we push function_calls onto the stack; see opt_push_wait_flag_call_stack_info
1054
1055		% expand the call stack by creating entries for the definition calls
1056		split_calls([],[]).
1057		split_calls([Call|T],NewCalls) :- nop_call(Call),!, %print(nop(Call)),nl,
1058		split_calls(T,NewCalls).
1059		split_calls([Call|T],NewCalls) :-
1060		get_call_stack_span(Call,Span),!,
1061		NewCalls = [Call|New2],
1062		extract_def_calls(Span,New2,ST),
1063		split_calls(T,ST).
1064		split_calls([Call|T],[Call|ST]) :-
1065		split_calls(T,ST).
1066
1067		extract_def_calls(Span) -->
1068		{extract_pos_context(Span,MainPos,Context,CtxtPos)},
1069		{Context = definition_call(Name)},
1070		!,
1071		extract_def_calls(MainPos),
1072		[definition_call(Name,CtxtPos)],
1073		extract_def_calls(CtxtPos). % do we need this??
1074		extract_def_calls(_) --> [].
1075
1076		% a shorter version of extract_additional_description only accepting definition_calls
1077		translate_additional_description(Span,Desc) :-
1078		extract_pos_context(Span,MainPos,Context,CtxtPos),
1079		translate_span(CtxtPos,CtxtAtom),
1080		extract_def_context_msg(Context,OuterCMsg),
1081		(translate_additional_description(MainPos,InnerCMsg)
1082		-> ajoin([InnerCMsg,' within ',OuterCMsg, ' ', CtxtAtom],Desc)
1083		; ajoin([OuterCMsg, ' ', CtxtAtom],Desc)
1084		).
1085
1086		% try and get an immediate definition call context for a position
1087		get_definition_context_from_span(Span,DefCtxtMsg) :-
1088		extract_pos_context(Span,_MainPos,Context,_CtxtPos),
1089		extract_def_context_msg(Context,DefCtxtMsg).
1090
1091		extract_def_context_msg(definition_call(Name),Msg) :- !, % static Definition macro expansion call stack
1092		ajoin(['DEFINITION call of ',Name],Msg).
1093
1094		render_paras([],[]) --> !, [].
1095		render_paras([],_Vals) --> ['...?...']. % should not happen
1096		render_paras([Name],[Val]) --> !, render_para_name(Name), ['='], render_para_val(Val).
1097		render_paras([Name|TN],[Val|TV]) --> !,
1098		render_para_name(Name), ['='], render_para_val(Val), [','],
1099		render_paras(TN,TV).
1100		render_paras([N|Names],[]) --> !, render_para_name(N), render_paras(Names,[]). % value list can be empty
1101
1102		render_para_val(Val) --> {get_cs_limit(Limit),translate_bvalue_with_limit(Val,Limit,VS)}, [VS].
1103
1104		% accept typed and atomic ids
1105		render_para_name(b(identifier(ID),_,_)) --> !, {translated_identifier(ID,TID)},[TID].
1106		render_para_name(ID) --> {translated_identifier(ID,TID)},[TID].
1107
1108		render_quantifier(lambda) --> !, {unicode_translation(lambda,Symbol)},[Symbol]. % ['{|}'].
1109		render_quantifier(comprehension_set) --> !, ['{|}'].
1110		render_quantifier(comprehension_set(NegationContext)) --> !,
1111		render_negation_context(NegationContext), [' {|}'].
1112		render_quantifier(exists) --> !, {unicode_translation(exists,Symbol)},[Symbol].
1113		render_quantifier(let_quantifier) --> !, ['LET'].
1114		render_quantifier(optimize) --> !, ['#optimize'].
1115		render_quantifier(forall) --> !, {unicode_translation(forall,Symbol)},[Symbol].
1116		render_quantifier(not(Q)) --> !, {unicode_translation(negation,Symbol)}, % not(exists)
1117		[Symbol, '('], render_quantifier(Q), [')'].
1118		render_quantifier(Q) --> !, [Q].
1119
1120		render_negation_context(positive) --> !, ['one solution'].
1121		render_negation_context(negative) --> !, ['no solution'].
1122		render_negation_context(all_solutions) --> !,['all solutions'].
1123		render_negation_context(C) --> [C].
1124
1125		call_stack_arrow_atom_symbol(' \x2192\ '). % see total function
1126		%call_stack_arrow_atom_symbol('\x27FF\ '). % long rightwards squiggle arrow
1127
1128		% -----------------
1129
1130
1131		is_init('$initialise_machine').
1132		is_init('$setup_constants').
1133
1134		translate_bvalues_with_types(Values,Types,Output) :-
1135		%set_up_limit_reached(Codes,1000,LimitReached),
1136		pp_value_l_with_types(Values,',',Types,_LimitReached,Codes,[]),!,
1137		atom_codes_with_limit(Output,Codes).
1138		translate_bvalues_with_types(Values,T,Output) :-
1139		add_internal_error('Call failed: ',translate_bvalues_with_types(Values,T,Output)),
1140		translate_bvalues(Values,Output).
1141
1142		pp_value_l_with_types([],_Sep,[],_) --> !.
1143		pp_value_l_with_types([Expr|Rest],Sep,[TE|TT],LimitReached) -->
1144		( {nonvar(Rest),Rest=[]} ->
1145		pp_value_with_type(Expr,TE,LimitReached)
1146		;
1147		pp_value_with_type(Expr,TE,LimitReached),ppatom(Sep),
1148		pp_value_l_with_types(Rest,Sep,TT,LimitReached)).
1149
1150
1151		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1152
1153		% pretty-print properties
1154		translate_properties_with_limit([],[]).
1155		translate_properties_with_limit([P|Prest],[Out|Orest]) :-
1156		translate_property_with_limit(P,320,Out), % reduced limit as we now have evaluation view + possibility to inspect all of value
1157		translate_properties_with_limit(Prest,Orest).
1158
1159		translate_property_with_limit(Prop,Limit,Output) :-
1160		(pp_property(Prop,Limit,Output) -> true ; (add_error(translate_property,'Could not translate property: ',Prop),Output='???')).
1161		pp_property(Prop,Limit,Output) :-
1162		pp_property_without_plugin(Prop,Limit,Output).
1163		pp_property_without_plugin(=(Key,Value),_,A) :-
1164		!,ajoin([Key,' = ',Value],A).
1165		pp_property_without_plugin(':'(Key,Value),_,A) :-
1166		!,ajoin([Key,' : ',Value],A).
1167		pp_property_without_plugin(info(I),_,I) :- !.
1168		pp_property_without_plugin(Prop,Limit,A) :-
1169		write_to_codes(Prop,Codes),
1170		atom_codes_with_limit(A,Limit,Codes).
1171
1172
1173		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1174		:- use_module(tools_meta,[translate_term_into_atom_with_max_depth/3]).
1175
1176		% pretty-print errors belonging to a certain state
1177		translate_error_term(Term,S) :- translate_error_term(Term,unknown,S).
1178		translate_error_term(Var,_,S) :- var(Var),!,
1179		translate_term_into_atom_with_max_depth(Var,5,S).
1180		translate_error_term('@fun'(X,F),Span,S) :-
1181		translate_bvalue(X,TX),
1182		(get_function_from_span(Span,Fun,LocState,State),
1183		translate_bexpression_with_limit(Fun,200,TSF)
1184		-> % we managed to extract the function from the span_predicate
1185		(is_compiled_value(Fun)
1186		-> (get_was_identifier(Fun,WasFunId) -> Rest = [', function: ',WasFunId | Rest1]
1187		; Rest = Rest1
1188		),
1189		TVal=TSF % use as value
1190		; Rest = [', function: ',TSF | Rest1],
1191		% try and extract value from span_predicate (often F=[] after traversing avl)
1192		(get_texpr_id(Fun,FID),
1193		(member(bind(FID,FVal),LocState) ; member(bind(FID,FVal),State))
1194		-> translate_bvalue(FVal,TVal)
1195		; translate_bvalue(F,TVal)
1196		)
1197		)
1198		; Rest=[], translate_bvalue(F,TVal)
1199		),!,
1200		% translate_term_into_atom_with_max_depth('@fun'(TX,TVal),5,S).
1201		(get_error_span_for_value(F,NewSpanTxt) % triggers in test 953
1202		-> Rest1 = [' defined at ',NewSpanTxt]
1203		; Rest1 = []
1204		),
1205		ajoin(['Function argument: ',TX, ', function value: ',TVal | Rest],S).
1206		translate_error_term('@rel'(Arg,Res1,Res2),_,S) :-
1207		translate_bvalue(Arg,TA), translate_bvalue(Res1,R1),
1208		translate_bvalue(Res2,R2),!,
1209		ajoin(['Function argument: ',TA, ', two possible values: ',R1,', ',R2],S).
1210		translate_error_term([operation(Name,Env)],_,S) :-
1211		translate_any_state(Env,TEnv), !,
1212		translate_term_into_atom_with_max_depth(operation(Name,TEnv),10,S).
1213		translate_error_term(error(E1,E2),_,S) :- !, translate_prolog_error(E1,E2,S).
1214		translate_error_term(b(B,T,I),_,S) :-
1215		translate_subst_or_bexpr_with_limit(b(B,T,I),1000,do_not_report_errors,S),!. % do not report errors, otherwise we end in an infinite loop of adding errors while adding errors
1216		translate_error_term([H|T],_,S) :- nonvar(H), H=b(_,_,_), % typically a list of typed ids
1217		E=b(sequence_extension([H|T]),any,[]),
1218		translate_subst_or_bexpr_with_limit(E,1000,do_not_report_errors,S),!.
1219		translate_error_term([H|T],_,S) :- nonvar(H), H=bind(_,_), % a store
1220		translate_bstate_limited([H|T],1000,S),!.
1221		translate_error_term(Term,_,S) :-
1222		is_bvalue(Term),
1223		translate_bvalue_with_limit(Term,1000,S),!.
1224		translate_error_term(T,_,S) :-
1225		(debug_mode(on) -> Depth = 20 ; Depth = 5),
1226		translate_term_into_atom_with_max_depth(T,Depth,S).
1227
1228		get_function_from_span(Var,Fun,_,_) :- var(Var), !,
1229		add_internal_error('Variable span:',get_function_from_span(Var,Fun)),fail.
1230		get_function_from_span(pos_context(Span,_,_),Fun,LS,S) :- get_function_from_span(Span,Fun,LS,S).
1231		get_function_from_span(span_predicate(b(function(Function,_Arg),_T,_I),LocalState,State),Function,LocalState,State).
1232
1233		is_compiled_value(b(value(_),_,_)).
1234
1235		get_was_identifier(b(_,_,Info),Id) :- member(was_identifier(Id),Info). % added e.g. by b_compiler
1236
1237		% TODO: complete this
1238		% for recognising B values as error terms and automatically translating them
1239		is_bvalue(V) :- var(V),!,fail.
1240		is_bvalue([]).
1241		is_bvalue(closure(_,_,_)).
1242		is_bvalue(fd(_,_)).
1243		is_bvalue(freetype(_)).
1244		is_bvalue(freeval(_,_,_)).
1245		is_bvalue(avl_set(_)).
1246		is_bvalue(int(_)).
1247		is_bvalue(global_set(_)).
1248		is_bvalue(pred_true).
1249		is_bvalue(pred_false).
1250		is_bvalue(string(_)).
1251		is_bvalue(term(_)). % typically term(floating(_))
1252		is_bvalue(rec(Fields)) :- nonvar(Fields), Fields=[F1|_], nonvar(F1),
1253		F1=field(_,V1), is_bvalue(V1).
1254		is_bvalue((A,B)) :-
1255		(nonvar(A) -> is_bvalue(A) ; true),
1256		(nonvar(B) -> is_bvalue(B) ; true).
1257
1258		% try and get error location for span:
1259		get_error_span_for_value(Var,_) :- var(Var),!,fail.
1260		get_error_span_for_value(closure(_,_,Body),Span) :- translate_span_with_filename(Body,Span), Span \= ''.
1261
1262
1263		% translate something that was caught with catch/3
1264		translate_prolog_exception(user_interrupt_signal,R) :- !, R='User-Interrupt (CTRL-C)'.
1265		translate_prolog_exception(enumeration_warning(_,_,_,_,_),R) :- !, R='Enumeration Warning'.
1266		translate_prolog_exception(error(E1,E2),S) :- !, translate_prolog_error(E1,E2,S).
1267		translate_prolog_exception(E1,S) :- translate_term_into_atom_with_max_depth(E1,8,S).
1268
1269		% translate a Prolog error(E1,E2) exception
1270		translate_prolog_error(existence_error(procedure,Pred),_,S) :- !,
1271		translate_term_into_atom_with_max_depth('Unknown Prolog predicate:'(Pred),8,S).
1272		translate_prolog_error(existence_error(source_sink,File),_,S) :- !,
1273		translate_term_into_atom_with_max_depth('File does not exist:'(File),8,S).
1274		translate_prolog_error(permission_error(Action,source_sink,File),_,S) :- !, % Action = open, ...
1275		ajoin(['Permission denied to ',Action,' the file: ',File],S).
1276		translate_prolog_error(permission_error(Action,past_end_of_stream,File),_,S) :- !, % Action = open, ...
1277		ajoin(['Permission denied to ',Action,' past end of file: ',File],S).
1278		translate_prolog_error(system_error,system_error('SPIO_E_NET_CONNRESET'),S) :- !,
1279		S = 'System error: connection to process lost (SPIO_E_NET_CONNRESET)'.
1280		translate_prolog_error(system_error,system_error('SPIO_E_ENCODING_UNMAPPABLE'),S) :- !,
1281		S = 'System error: illegal character or encoding encountered (SPIO_E_ENCODING_UNMAPPABLE)'.
1282		translate_prolog_error(system_error,system_error('SPIO_E_NET_HOST_NOT_FOUND'),S) :- !,
1283		S = 'System error: could not find host (SPIO_E_NET_HOST_NOT_FOUND)'.
1284		translate_prolog_error(system_error,system_error('SPIO_E_CHARSET_NOT_FOUND'),S) :- !,
1285		S = 'System error: could not find character set encoding'.
1286		translate_prolog_error(system_error,system_error('SPIO_E_OS_ERROR'),S) :- !,
1287		S = 'System error due to some OS/system call (SPIO_E_OS_ERROR)'.
1288		translate_prolog_error(system_error,system_error('SPIO_E_END_OF_FILE'),S) :- !,
1289		S = 'System error: end of file (SPIO_E_END_OF_FILE)'.
1290		translate_prolog_error(system_error,system_error('SPIO_E_TOO_MANY_OPEN_FILES'),S) :- !,
1291		S = 'System error: too many open files (SPIO_E_TOO_MANY_OPEN_FILES)'.
1292		translate_prolog_error(system_error,system_error(dlopen(Msg)),S) :- !,
1293		translate_term_into_atom_with_max_depth(Msg,4,MS),
1294		ajoin(['System error: could not load dynamic library (you may have to right-click on the library and open it in the macOS Finder): ', MS],S).
1295		translate_prolog_error(system_error,system_error(Err),S) :- !,
1296		% or Err is an atom dlopen( mach-o file, but is an incompatible architecture ...)
1297		% E.g., SPIO_E_NOT_SUPPORTED when doing open('/usr',r,S)
1298		translate_term_into_atom_with_max_depth('System error:'(Err),8,S).
1299		translate_prolog_error(existence_error(procedure,Module:Pred/Arity),_,S) :- !,
1300		ajoin(['Prolog predicate does not exist: ',Module,':', Pred, '/',Arity],S).
1301		translate_prolog_error(instantiation_error,instantiation_error(Call,_ArgNo),S) :- !,
1302		translate_term_into_atom_with_max_depth('Prolog instantiation error:'(Call),8,S).
1303		translate_prolog_error(uninstantiation_error(_),uninstantiation_error(Call,_ArgNo,_Culprit),S) :- !,
1304		translate_term_into_atom_with_max_depth('Prolog uninstantiation error:'(Call),8,S).
1305		translate_prolog_error(evaluation_error(zero_divisor),evaluation_error(Call,_,_,_),S) :- !,
1306		translate_term_into_atom_with_max_depth('Division by zero error:'(Call),8,S).
1307		translate_prolog_error(evaluation_error(float_overflow),evaluation_error(Call,_,_,_),S) :- !,
1308		translate_term_into_atom_with_max_depth('Float overflow:'(Call),8,S).
1309		translate_prolog_error(representation_error(Err),representation_error(Call,_,_),S) :-
1310		memberchk(Err, ['CLPFD integer overflow','max_clpfd_integer','min_clpfd_integer']),!,
1311		translate_term_into_atom_with_max_depth('Prolog CLP(FD) overflow:'(Call),8,S).
1312		% TODO: domain_error(list_to_fdset(FDLIST,_989819),_,_,_L)
1313		translate_prolog_error(syntax_error(Err),_,S) :- !,
1314		translate_term_into_atom_with_max_depth('Prolog syntax error:'(Err),8,S).
1315		translate_prolog_error(_,resource_error(open(File,Mode,_),Kind),S) :- !, % Kind e.g. file_handle
1316		ajoin(['Resource error (',Kind,
1317		'), could not open file ',File,' in mode ',Mode],S).
1318		:- if(predicate_property(message_to_string(_, _), _)).
1319		translate_prolog_error(E1,E2,S) :-
1320		% SWI-Prolog way to translate an arbitrary message term (such as an exception) to a string,
1321		% the same way that the built-in message handling system would print it.
1322		message_to_string(error(E1,E2), String),
1323		!,
1324		atom_string(S, String).
1325		:- endif.
1326		translate_prolog_error(E1,_,S) :- translate_term_into_atom_with_max_depth(E1,8,S).
1327		% we also have permission_error, context_error, domain_error
1328
1329		translate_state_errors([],[]).
1330		translate_state_errors([E|ERest],[Out|ORest]) :-
1331		( E = eventerror(Event,EError,_) ->
1332		translate_event_error(EError,Msg),
1333		ajoin([Event,': ',Msg],Out)
1334		; translate_state_error(E,Out) -> true
1335		; functor(E,Out,_) ),
1336		translate_state_errors(ERest,ORest).
1337
1338		translate_error_context(E,TE) :- translate_error_context2(E,Codes,[]),
1339		atom_codes_with_limit(TE,Codes).
1340		translate_error_context2(span_context(Span,Context)) --> !,
1341		translate_error_context2(Context),
1342		translate_span(Span,only_subsidiary).
1343		translate_error_context2([H]) --> !,translate_error_context2(H).
1344		translate_error_context2(checking_invariant) --> !,
1345		{get_specification_description_codes(invariant,A)}, A. %"INVARIANT".
1346		translate_error_context2(checking_assertions) --> !,
1347		{get_specification_description_codes(assertions,A)}, A. %"ASSERTIONS".
1348		translate_error_context2(checking_negation_of_invariant(_State)) --> !,
1349		"not(INVARIANT)".
1350		translate_error_context2(operation(OpName,_State)) --> !,
1351		{translate_operation_name(OpName,TOp)},
1352		ppterm(TOp).
1353		translate_error_context2(checking_context(Check,Name)) --> !,
1354		ppterm(Check),ppterm(Name).
1355		translate_error_context2(loading_context(_Name)) --> !.
1356		translate_error_context2(visb_error_context(Class,SvgId,OpNameOrAttr,Span)) --> !,
1357		"VisB ", ppterm(Class), " for SVG ID ",
1358		ppterm(SvgId), " and attribute/event ",
1359		{translate_operation_name(OpNameOrAttr,TOp)},
1360		ppterm(TOp),
1361		translate_span(Span,only_subsidiary).
1362		translate_error_context2(X) --> "???:", ppterm(X).
1363
1364		print_span(Span) :- translate_span(Span,Atom), !, print(Atom).
1365		print_span(S) :- print(span(S)).
1366
1367		print_span_nl(Span) :- translate_span(Span,Atom), !,(Atom='' -> true ; print(Atom)),nl.
1368		print_span_nl(S) :- print(span(S)),nl.
1369
1370
1371		translate_span(Span,Atom) :- translate_span(Span,only_subsidiary,Codes,[]),
1372		atom_codes_with_limit(Atom,Codes).
1373		translate_span_with_filename(Span,Atom) :-
1374		translate_span(Span,always_print_filename,Codes,[]),
1375		atom_codes_with_limit(Atom,Codes).
1376
1377		translate_span(Span,_) --> {var(Span)},!, {add_internal_error('Variable span:',translate_span(Span,_))}, "_".
1378		translate_span(Span,PrintFileNames) --> {extract_line_col(Span,Srow,Scol,_Erow,_Ecol)},!,
1379		"(Line:",ppterm(Srow)," Col:",ppterm(Scol),
1380		%"-",ppterm(Erow),":",ppterm(Ecol),
1381		translate_span_file_opt(Span,PrintFileNames),
1382		% TO DO: print short version of extract_additional_description ?
1383		")".
1384		translate_span(Span,_PrintFileNames) --> {extract_symbolic_label(Span,Label)},!, "(label @",ppterm(Label),")".
1385		translate_span(Span,PrintFileNames) -->
1386		% for Event-B, e.g., line-col fails but we can get a section/file name
1387		"(File:",translate_span_file(Span,PrintFileNames),!,")".
1388		translate_span(_,_PrintFileNames) --> "".
1389
1390		translate_span_file(Span,always_print_filename) -->
1391		{extract_tail_file_name(Span,Filename)},!,
1392		%{bmachine:b_get_main_filenumber(MainFN), Nr \= MainFN},!,
1393		" File:", ppterm(Filename).
1394		translate_span_file(Span,_) -->
1395		{extract_subsidiary_tail_file_name(Span,Filename)},
1396		%{bmachine:b_get_main_filenumber(MainFN), Nr \= MainFN},!,
1397		!,
1398		" File:", ppterm(Filename).
1399		translate_span_file_opt(Span,Print) --> translate_span_file(Span,Print),!.
1400		translate_span_file_opt(_,_) --> "".
1401
1402
1403		explain_span_file(Span) -->
1404		{extract_subsidiary_tail_file_name(Span,Filename)},
1405		%{bmachine:b_get_main_filenumber(MainFN), Nr \= MainFN},!,
1406		"\n### File: ", ppterm(Filename).
1407		explain_span_file(_) --> "".
1408
1409		explain_span(V) --> {var(V)},!, "Internal error: Illegal variable span".
1410		explain_span(span_predicate(Pred,LS,S)) --> !, explain_span2(span_predicate(Pred,LS,S)),
1411		explain_local_state(LS). %, explain_global_state(S).
1412		explain_span(Span) --> explain_span2(Span).
1413		explain_span2(Span) --> {extract_line_col(Span,Srow,Scol,Erow,Ecol)},!,
1414		"\n### Line: ", ppterm(Srow), ", Column: ", ppterm(Scol),
1415		" until Line: ", ppterm(Erow), ", Column: ", ppterm(Ecol),
1416		explain_span_file(Span),
1417		explain_span_context(Span).
1418		explain_span2(Span) --> {extract_symbolic_label_pos(Span,Msg)},!,
1419		"\n @label: ", ppterm(Msg),
1420		explain_span_context(Span).
1421		explain_span2(Span) --> explain_span_context(Span).
1422
1423		explain_span_context(Span) --> {extract_additional_description(Span,Msg),!},
1424		"\n### within ", ppterm(Msg). % context of span, such as definition call hierarchy
1425		explain_span_context(_) --> "".
1426
1427		explain_local_state([]) --> !, "".
1428		explain_local_state(LS) --> "\n Local State: ", pp_b_state(LS,1000).
1429		%explain_global_state([]) --> !, "".
1430		%explain_global_state(LS) --> "\n Global State: ", pp_b_state(LS).
1431
1432		translate_event_error(Error,Out) :-
1433		( translate_event_error2(Error,Out) -> true
1434		;
1435		functor(Error,F,_),
1436		ajoin(['** Unable to translate event error: ',F,' **'],Out)).
1437		translate_event_error2(no_witness_found(Type,Var,_Predicate),Out) :-
1438		def_get_texpr_id(Var,Id),
1439		ajoin(['no witness was found for ',Type,' ',Id],Out).
1440		translate_event_error2(simulation_error(_Events),Out) :-
1441		Out = 'no matching abstract event was found'.
1442		translate_event_error2(action_not_executable(_Action,WDErr),Out) :-
1443		(WDErr=wd_error_possible -> Out = 'action was not executable (maybe with WD error)'
1444		; Out = 'action was not executable').
1445		translate_event_error2(invalid_modification(Var,_Pre,_Post),Out) :-
1446		def_get_texpr_id(Var,Id),
1447		ajoin(['modification of variable ', Id, ' not allowed'],Out).
1448		translate_event_error2(variant_negative(_CType,_Variant,_Value),Out) :-
1449		Out = 'enabled for negative variant'.
1450		translate_event_error2(invalid_variant(anticipated,_Expr,_Pre,_Post),Out) :-
1451		Out = 'variant increased'.
1452		translate_event_error2(invalid_variant(convergent,_Expr,_Pre,_Post),Out) :-
1453		Out = 'variant not decreased'.
1454		translate_event_error2(invalid_theorem_in_guard(_Theorem),Out) :-
1455		Out = 'theorem in guard evaluates to false'.
1456		translate_event_error2(event_wd_error(_TExpr,Source),Out) :-
1457		ajoin(['WD error for ',Source],Out).
1458		translate_event_error2(event_other_error(Msg),Out) :- Out=Msg.
1459
1460		translate_state_error(abort_error(_TYPE,Msg,ErrTerm,ErrorContext),Out) :- !,
1461		translate_error_term(ErrTerm,ES),
1462		translate_error_context(ErrorContext,EC),
1463		ajoin([EC,': ',Msg,': ',ES],Out).
1464		translate_state_error(clpfd_overflow_error(Context),Out) :- !, % 'CLPFD_integer_overflow'
1465		ajoin(['CLPFD integer overflow while ', Context],Out).
1466		translate_state_error(max_state_errors_reached(Nr),Out) :- !,
1467		ajoin(['Max. number of state errors reached: ', Nr],Out).
1468		translate_state_error(Unknown,Out) :-
1469		add_error(translate_state_error,'Unknown state error: ',Unknown),
1470		Out = '*** Unknown State Error ***'.
1471
1472
1473		get_span_from_context([H],Span) :- !, get_span_from_context(H,Span).
1474		get_span_from_context(span_context(Span,_),Res) :- !, Res=Span.
1475		get_span_from_context(_,unknown).
1476
1477		explain_error_context1([H]) --> !,explain_error_context1(H).
1478		explain_error_context1(span_context(Span,Context)) --> !,
1479		explain_span(Span),"\n",
1480		explain_error_context2(Context).
1481		explain_error_context1(Ctxt) --> explain_error_context2(Ctxt).
1482
1483		explain_error_context2([H]) --> !,explain_error_context2(H).
1484		explain_error_context2(span_context(Span,Context)) --> !,
1485		explain_span(Span),"\n",
1486		explain_error_context2(Context).
1487		explain_error_context2(checking_invariant) --> !,
1488		{get_specification_description_codes(invariant,I)}, I, ":\n ", %"INVARIANT:\n ",
1489		pp_current_state. % assumes explain is called in the right state ! ; otherwise we need to store the state id
1490		explain_error_context2(checking_assertions) --> !,
1491		{get_specification_description_codes(assertions,A)}, A, ":\n ", %"ASSERTIONS:\n ",
1492		pp_current_state. % assumes explain is called in the right state ! ; otherwise we need to store the state id
1493		explain_error_context2(checking_negation_of_invariant(State)) --> !,
1494		"not(INVARIANT):\n State: ",
1495		pp_b_state(State,1000).
1496		explain_error_context2(operation('$setup_constants',StateID)) --> !,
1497		{get_specification_description_codes(properties,P)}, P, ":\n State: ",
1498		pp_context_state(StateID).
1499		explain_error_context2(operation(OpName,StateID)) --> !,
1500		{get_specification_description_codes(operation,OP)}, OP, ": ", %"EVENT/OPERATION: ",
1501		{translate_operation_name(OpName,TOp)},
1502		ppterm(TOp), "\n ",
1503		pp_context_state(StateID).
1504		explain_error_context2(checking_context(Check,Name)) --> !,
1505		ppterm(Check),ppterm(Name), "\n ".
1506		explain_error_context2(loading_context(Name)) --> !,
1507		"Loading: ",ppterm(Name), "\n ".
1508		explain_error_context2(visb_error_context(Class,SvgId,OpNameOrAttr,Span)) --> !,
1509		translate_error_context2(visb_error_context(Class,SvgId,OpNameOrAttr,Span)).
1510		explain_error_context2(X) --> "UNKNOWN ERROR CONTEXT:\n ", ppterm(X).
1511
1512		:- use_module(specfile,[get_specification_description/2]).
1513		get_specification_description_codes(Tag,Codes) :- get_specification_description(Tag,Atom), atom_codes(Atom,Codes).
1514
1515		explain_state_error(Error,Span,Out) :-
1516		explain_state_error2(Error,Span,Out,[]),!.
1517		explain_state_error(_Error,unknown,"Sorry, the detailed output failed.\n").
1518
1519		explain_abort_error_type(well_definedness_error) --> !, "An expression was not well-defined.\n".
1520		explain_abort_error_type(card_overflow_error) --> !, "The cardinality of a finite set was too large to be represented.\n".
1521		explain_abort_error_type(while_variant_error) --> !, "A while-loop VARIANT error occurred.\n".
1522		explain_abort_error_type(while_invariant_violation) --> !, "A while-loop INVARIANT error occurred.\n".
1523		explain_abort_error_type(precondition_error) --> !, "A precondition (PRE) error occurred.\n".
1524		explain_abort_error_type(assert_error) --> !, "An ASSERT error occurred.\n".
1525		explain_abort_error_type(Type) --> "Error occurred: ", ppterm(Type), "\n".
1526
1527		explain_state_error2(abort_error(TYPE,Msg,ErrTerm,ErrContext),Span) -->
1528		explain_abort_error_type(TYPE),
1529		"Reason: ", ppterm(Msg), "\n",
1530		{get_span_from_context(ErrContext,Span)},
1531		({ErrTerm=''} -> ""
1532		; "Details: ", {translate_error_term(ErrTerm,Span,ErrS)},ppterm(ErrS), "\n"
1533		),
1534		"Context: ", explain_error_context1(ErrContext).
1535		explain_state_error2(max_state_errors_reached(Nr),unknown) -->
1536		"Too many error occurred for this state.\n",
1537		"Not all errors are shown.\n",
1538		"Number of errors is at least: ", ppterm(Nr).
1539		explain_state_error2(eventerror(_Event,Error,Trace),Span) --> % TO DO: also extract loc info ?
1540		{translate_event_error(Error,Msg)},
1541		ppatom(Msg),
1542		"\nA detailed trace containing the error:\n",
1543		"--------------------------------------\n",
1544		explain_event_trace(Trace,Span).
1545		explain_state_error2(clpfd_overflow_error(Context),unknown) --> % CLPFD_integer_overflow
1546		"An overflow occurred inside the CLP(FD) library.\n",
1547		"Context: ", ppterm(Context), "\n",
1548		"You may try and set the CLPFD preference to FALSE.\n".
1549
1550		% try and get span from state error:
1551		get_state_error_span(abort_error(_,_,_,Context),Span) :- get_span_context_span(Context,Span).
1552
1553		get_span_context_span(span_context(Span,_),Span).
1554		get_span_context_span([H],Span) :- get_span_context_span(H,Span).
1555
1556
1557
1558		show_parameter_values([],[]) --> !.
1559		show_parameter_values([P|Prest],[V|Vrest]) -->
1560		show_parameter_value(P,V),
1561		show_parameter_values(Prest,Vrest).
1562		show_parameter_value(P,V) -->
1563		" ",pp_expr(P,_,_LR)," = ",pp_value(V),"\n".
1564
1565		% translate an Event-B error trace (error occurred during multi-level animation)
1566		% into a textual description (Codes) and a span_predicate term which can be visualised
1567		explain_event_trace(Trace,Codes,Span) :-
1568		explain_event_trace(Trace,Span,Codes,[]).
1569
1570		explain_event_trace(Trace,span_predicate(SpanPred,[],[])) -->
1571		% evaluating the span predicate will require access to current state, which needs to be added later
1572		explain_event_trace4(Trace,'?','?',SpanPred).
1573
1574		explain_event_trace4([],_,_,b(truth,pred,[])) --> !.
1575		explain_event_trace4([event(Name,Section)|Trest],_,_,SpanPred) --> !,
1576		"\n",
1577		"Event ",ppterm(Name)," in model ",ppterm(Section),
1578		":\n",
1579		% pass new current event name and section for processing tail:
1580		explain_event_trace4(Trest,Name,Section,SpanPred).
1581		explain_event_trace4([Step|Trest],Name,Section,SpanPred) -->
1582		"\n",
1583		( explain_event_step4(Step,StepPred) -> ""
1584		; {functor(Step,F,_)} ->
1585		" (no rule to explain event step ",ppatom(F),")\n"),
1586		explain_event_trace4(Trest,Name,Section,RestSpanPred),
1587		{combine_span_pred(StepPred,RestSpanPred,Name,Section,SpanPred)}.
1588
1589		% create a span predicate from the event error trace to display relevant values and predicates
1590		combine_span_pred(unknown,S,_,_,Res) :- !, Res=S.
1591		combine_span_pred(new_scope(Kind,Paras,Vals,P1),P2,Name,Section,Res) :- !,
1592		maplist(create_tvalue,Paras,Vals,TVals),
1593		add_span_label(Kind,Name,Section,P1,P1L),
1594		conjunct_predicates([P1L,P2],Body),
1595		(Paras=[] -> Res=Body ; Res = b(let_predicate(Paras,TVals,Body),pred,[])). % translate:print_bexpr(Res),nl.
1596		% we could also do: add_texpr_description
1597		combine_span_pred(P1,P2,_,_,Res) :-
1598		conjunct_predicates([P1,P2],Res).
1599
1600		add_span_label(Kind,Name,Section,Pred,NewPred) :-
1601		(Kind=[Label] -> true % already has position info
1602		; create_label(Kind,Name,Section,Label)),
1603		add_labels_to_texpr(Pred,[Label],NewPred).
1604		create_label(Kind,Name,Section,Label) :- ajoin([Kind,' in ',Section,':',Name],Label).
1605
1606		create_tvalue(b(_,Type,_),Value,b(value(Value),Type,[])).
1607
1608		explain_event_step4(true_guard(Parameters,Values,Guard),new_scope('guard true',Parameters,Values,Guard)) --> !,
1609		( {Parameters==[]} -> ""
1610		; " for the parameters:\n",
1611		show_parameter_values(Parameters,Values)),
1612		" the guard is true:",
1613		explain_predicate(Guard,4),"\n".
1614		explain_event_step4(eval_witness(Type,Id,Value,Predicate),new_scope('witness',[Id],[Value],Predicate)) -->
1615		witness_intro(Id,Predicate,Type),
1616		" found witness:\n",
1617		" ", pp_expr(Id,_,_LR), " = ", pp_value(Value), "\n".
1618		explain_event_step4(simulation_error(Errors),SpanPred) -->
1619		" no guard of a refined event was satisfiable:\n",
1620		explain_simulation_errors(Errors,Guards),
1621		{disjunct_predicates(Guards,SpanPred)}.
1622		explain_event_step4(invalid_theorem_in_guard(Theorem),new_scope('false theorem',[],[],Theorem)) -->
1623		" the following theorem evaluates to false:",
1624		explain_predicate(Theorem,4),"\n".
1625		explain_event_step4(invalid_modification(Var,Pre,Post),
1626		new_scope('invalid modification',[Var],[Post],b(falsity,pred,[]))) -->
1627		" the variable ", pp_expr(Var,_,_LR), " has been modified.\n",
1628		" The event is not allowed to modify the variable because its abstract event does not modify it.\n",
1629		" Old value: ", pp_value(Pre), "\n",
1630		" New value: ", pp_value(Post), "\n".
1631		explain_event_step4(action_not_executable(TAction,WDErr),new_scope('action not executable',[],[],Equalities)) -->
1632		{exctract_span_pred_from_subst(TAction,Equalities)},
1633		explain_action_not_executable(TAction,WDErr).
1634		explain_event_step4(Step,unknown) -->
1635		explain_event_step(Step).
1636		% TODO: add span predicates for the errors below:
1637
1638		extract_equality(Infos,TID,NewExpr,b(equal(TID,NewExpr),pred,Infos)). % TODO: introduce TID' primed?
1639		exctract_span_pred_from_subst(b(assign(TIDs,Exprs),subst,Infos),SpanPred) :-
1640		maplist(extract_equality(Infos),TIDs,Exprs,List),
1641		conjunct_predicates(List,SpanPred).
1642		% todo: becomes_such, ...
1643
1644		explain_event_step(variant_checked_pre(CType,Variant,Value)) -->
1645		" ",ppatom(CType)," event: checking if the variant is non-negative:\n",
1646		" variant: ",pp_expr(Variant,_,_LR),"\n",
1647		" its value: ",pp_value(Value),"\n".
1648		explain_event_step(variant_negative(CType,Variant,Value)) -->
1649		explain_event_step(variant_checked_pre(CType,Variant,Value)),
1650		" ERROR: variant is negative\n".
1651		explain_event_step(variant_checked_post(CType,Variant,EntryValue,ExitValue)) -->
1652		" ",ppatom(CType)," event: checking if the variant is ",
1653		( {CType==convergent} -> "decreased:\n" ; "not increased:\n"),
1654		" variant: ", pp_expr(Variant,_,_LR), "\n",
1655		" its value before: ", pp_value(EntryValue),"\n",
1656		" its value after: ", pp_value(ExitValue),"\n".
1657		explain_event_step(invalid_variant(CType,Variant,EntryValue,ExitValue)) -->
1658		explain_event_step(variant_checked_post(CType,Variant,EntryValue,ExitValue)),
1659		" ERROR: variant has ",
1660		({CType==convergent} -> "not been decreased\n"; "has been increased\n").
1661		explain_event_step(no_witness_found(Type,Id,Predicate)) -->
1662		witness_intro(Id,Predicate,Type),
1663		" ERROR: no solution for witness predicate found!\n".
1664		explain_event_step(action(Lhs,_Rhs,Values)) -->
1665		" executing an action:\n",
1666		show_assignments(Lhs,Values).
1667		explain_event_step(action_set(Lhs,_Rhs,ValueSet,Values)) -->
1668		" executing an action:\n ",
1669		pp_expr_l(Lhs,_LR)," :: ",pp_value(ValueSet),"\n choosing\n",
1670		show_assignments(Lhs,Values).
1671		explain_event_step(action_pred(Ids,Pred,Values)) -->
1672		" executing an action:\n ",
1673		pp_expr_l(Ids,_LR1)," :| ",pp_expr(Pred,_,_LR2),"\n choosing\n",
1674		show_assignments(Ids,Values).
1675		explain_event_step(error(Error,_Id)) -->
1676		% the error marker serves to link to a stored state-error by its ID
1677		explain_event_step(Error).
1678		explain_event_step(event_wd_error(TExpr,Source)) -->
1679		" Well-Definedness ERROR for ", ppatom(Source), "\n",
1680		" ", pp_expr(TExpr,_,_LR), "\n".
1681		explain_event_step(event_other_error(Msg)) --> ppatom(Msg).
1682
1683		explain_action_not_executable(TAction,no_wd_error) --> {is_assignment_to(TAction,IDs)},!,
1684		" ERROR: the following assignment to ", ppatoms(IDs),"was not executable\n",
1685		" (probably in conflict with another assignment, check SIM or EQL PO):", % or WD error
1686		translate_subst_with_indention_and_label(TAction,4).
1687		explain_action_not_executable(TAction,wd_error_possible) --> !,
1688		" ERROR: the following action was not executable\n",
1689		" (possibly due to a WD error):",
1690		translate_subst_with_indention_and_label(TAction,4).
1691		explain_action_not_executable(TAction,_WDErr) -->
1692		" ERROR: the following action was not executable:",
1693		translate_subst_with_indention_and_label(TAction,4).
1694
1695		is_assignment_to(b(assign(LHS,_),_,_),IDs) :- get_texpr_ids(LHS,IDs).
1696
1697		witness_intro(Id,Predicate,Type) -->
1698		" evaluating witness for abstract ", ppatom(Type), " ", pp_expr(Id,_,_LR1), "\n",
1699		" witness predicate: ", pp_expr(Predicate,_,_LR2), "\n".
1700
1701		show_assignments([],[]) --> !.
1702		show_assignments([Lhs|Lrest],[Val|Vrest]) -->
1703		" ",pp_expr(Lhs,_,_LimitReached), " := ", pp_value(Val), "\n",
1704		show_assignments(Lrest,Vrest).
1705
1706		/* unused at the moment:
1707		explain_state([]) --> !.
1708		explain_state([bind(Varname,Value)|Rest]) --> !,
1709		" ",ppterm(Varname)," = ",pp_value(Value),"\n",
1710		explain_state(Rest).
1711		explain_guards([]) --> "".
1712		explain_guards([Event|Rest]) -->
1713		{get_texpr_expr(Event,rlevent(Name,_Section,_Status,_Params,Guard,_Theorems,_Act,_VWit,_PWit,_Unmod,_Evt))},
1714		"\n",ppatom(Name),":",
1715		explain_predicate(Guard),
1716		explain_guards(Rest).
1717		explain_predicate(Guard,I,O) :-
1718		explain_predicate(Guard,2,I,O).
1719		*/
1720		explain_predicate(Guard,Indention,I,O) :-
1721		pred_over_lines(0,'@grd',Guard,(Indention,I),(_,O)).
1722
1723		explain_simulation_errors([],[]) --> !.
1724		explain_simulation_errors([Error|Rest],[Grd|Gs]) -->
1725		explain_simulation_error(Error,Grd),
1726		explain_simulation_errors(Rest,Gs).
1727		explain_simulation_error(event(Name,Section,Guard),SpanPred) -->
1728		{add_span_label('guard false',Name,Section,Guard,SpanPred)},
1729		" guard for event ", ppatom(Name),
1730		" in ", ppatom(Section), ":",
1731		explain_predicate(Guard,6),"\n".
1732
1733		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1734		% pretty-print a state
1735
1736
1737		print_state(State) :- b_state(State), !,print_bstate(State).
1738		print_state(csp_and_b_root) :- csp_with_bz_mode, !,
1739		print('(MAIN || B)').
1740		print_state(csp_and_b(CSPState,BState)) :- csp_with_bz_mode, !,
1741		print_bstate(BState), translate_cspm_state(CSPState,Text), print(Text).
1742		print_state(CSPState) :- csp_mode,!,translate_cspm_state(CSPState,Text), print(Text).
1743		print_state(State) :- animation_mode(xtl),!,print(State).
1744		print_state(State) :- print('*** Unknown state: '),print(State).
1745
1746		b_state(root).
1747		b_state(concrete_constants(_)).
1748		b_state(const_and_vars(_,_)).
1749		b_state(expanded_const_and_vars(_,_,_,_)).
1750		b_state(expanded_vars(_,_)).
1751		b_state([bind(_,_)|_]).
1752		b_state([]).
1753
1754		print_bstate(State) :- print_bstate_limited(State,1000,-1).
1755		print_bstate_limited(State,VarLimit,OverallLimit) :-
1756		translate_bstate_limited(State,VarLimit,OverallLimit,Output), print(' '),print(Output).
1757
1758		translate_any_state(State,Output) :-
1759		get_pp_state_limit(Limit),
1760		pp_any_state(State,Limit,Codes,[]),
1761		atom_codes_with_limit(Output,Codes).
1762		translate_bstate(State,Output) :-
1763		get_pp_state_limit(Limit),
1764		pp_b_state(State,Limit,Codes,[]),
1765		atom_codes_with_limit(Output,Codes).
1766
1767		get_pp_state_limit(Limit) :-
1768		(get_preference(expand_avl_upto,-1) -> Limit = -1 ; Limit = 1000).
1769
1770		% a version which tries to generate smaller strings
1771		translate_bstate_limited(State,Output) :-
1772		temporary_set_preference(expand_avl_upto,2,CHNG),
1773		call_cleanup(translate_bstate_limited(State,200,Output),
1774		reset_temporary_preference(expand_avl_upto,CHNG)).
1775
1776		translate_bstate_limited(State,Limit,Output) :-
1777		translate_bstate_limited(State,Limit,Limit,Output).
1778		translate_bstate_limited(State,VarLimit,Limit,Output) :-
1779		pp_b_state(State,VarLimit,Codes,[]), % this limit VarLimit applies to every variable
1780		atom_codes_with_limit(Output,Limit,Codes). % Limit applies to the full translation
1781
1782		pp_b_state(X,Limit) --> try_pp_b_state(X,Limit),!.
1783		pp_b_state(X,_Limit) --> {add_error(pp_b_state,'Could not translate state: ',X)}.
1784
1785		% Limit is pretty-print limit for every value printed
1786		try_pp_b_state(VAR,_) --> {var(VAR)},!, "_?VAR?_", {add_error(pp_b_state,'Variable state: ',VAR)}.
1787		try_pp_b_state(root,_) --> !, "root".
1788		try_pp_b_state(concrete_constants(Constants),Limit) --> !,"Constants: ",
1789		pp_b_state(Constants,Limit).
1790		try_pp_b_state(const_and_vars(ID,Vars),Limit) --> !,
1791		"Constants:",ppterm(ID),", Vars:",
1792		{set_translation_constants(ID)}, /* extract constants which stand for deferred set elements */
1793		pp_b_state(Vars,Limit),
1794		{clear_translation_constants}.
1795		try_pp_b_state(expanded_const_and_vars(ID,Vars,_,_Infos),Limit) --> !, "EXPANDED ",
1796		try_pp_b_state(const_and_vars(ID,Vars),Limit).
1797		try_pp_b_state(expanded_vars(Vars,_Infos),Limit) --> !, "EXPANDED ",
1798		try_pp_b_state(Vars,Limit).
1799		try_pp_b_state([],_) --> !, "/* empty state */".
1800		try_pp_b_state([bind(Varname,Value)|Rest],Limit) --> !,
1801		"( ",ppterm(Varname),"=",
1802		dcg_set_up_limit_reached(Limit,LimitReached),
1803		pp_value(Value,LimitReached),
1804		({Rest = []} -> []; " ",and_symbol,"\n "),
1805		pp_b_state_list(Rest,Limit).
1806
1807
1808		pp_b_state_list([],_) --> !, " )".
1809		pp_b_state_list([bind(Varname,Value)|Rest],Limit) --> !,
1810		ppterm(Varname),"=",
1811		dcg_set_up_limit_reached(Limit,LimitReached),
1812		pp_value(Value,LimitReached),
1813		({Rest = []} -> [] ; " ",and_symbol,"\n "),
1814		pp_b_state_list(Rest,Limit).
1815		pp_b_state_list(X,_) --> {add_error(pp_b_state_list,'Could not translate: ',X)}.
1816
1817		% a version of pp which generates no newline; can be used for printing SETUP_CONSTANTS, INITIALISATION
1818		pp_b_state_comma_list([],_,_) --> !, ")".
1819		pp_b_state_comma_list(_,Cur,Limit) --> {Cur >= Limit}, !, "...".
1820		pp_b_state_comma_list([bind(Varname,Value)|Rest],Cur,Limit) --> !,
1821		%{print(c(Varname,Cur,Limit)),nl},
1822		start_size(Ref),
1823		ppterm(Varname),"=",
1824		pp_value(Value),
1825		({Rest = []}
1826		-> ")"
1827		; ",",
1828		end_size(Ref,Size), % compute size increase wrt Ref point
1829		{Cur1 is Cur+Size},
1830		pp_b_state_comma_list(Rest,Cur1,Limit)
1831		).
1832		pp_b_state_comma_list(X,_,_) --> {add_error(pp_b_state_comma_list,'Could not translate: ',X)}.
1833
1834		start_size(X,X,X).
1835		end_size(RefVar,Len,X,X) :- % compute how many chars the dcg has added wrt start_size
1836		len(RefVar,X,Len).
1837		len(Var,X,Len) :- (var(Var) ; Var==X),!, Len=0.
1838		len([],_,0).
1839		len([_|T],X,Len) :- len(T,X,L1), Len is L1+1.
1840
1841		% can be used e.g. for setup_constants, initialise
1842		translate_b_state_to_comma_list_codes(FUNCTORCODES,State,Limit,ResCodes) :-
1843		pp_b_state_comma_list(State,0,Limit,Codes,[]),
1844		append("(",Codes,C0),
1845		append(FUNCTORCODES,C0,ResCodes).
1846
1847		% translate to a single line without newlines
1848		translate_b_state_to_comma_list(State,Limit,ResAtom) :-
1849		pp_b_state_comma_list(State,0,Limit,Codes,[]),
1850		append("(",Codes,C0),
1851		atom_codes(ResAtom,C0).
1852
1853		% ----------------
1854
1855		% printing and translating error contexts
1856		print_context(State) :- translate_context(State,Output), print(Output).
1857
1858		translate_context(Context,Output) :-
1859		pp_b_context(Context,Codes,[]),
1860		atom_codes_with_limit(Output,250,Codes).
1861
1862		pp_b_context([]) --> !.
1863		pp_b_context([C|Rest]) --> !,
1864		pp_b_context(C),
1865		pp_b_context(Rest).
1866		pp_b_context(translate_context) --> !, " ERROR CONTEXT: translate_context". % error occurred within translate_context
1867		pp_b_context(span_context(Span,Context)) --> !,
1868		pp_b_context(Context), " ", translate_span(Span,only_subsidiary).
1869		pp_b_context(operation(Name,StateID)) --> !,
1870		" ERROR CONTEXT: ",
1871		{get_specification_description_codes(operation,OP)}, OP, ":", % "OPERATION:"
1872		({var(Name)} -> ppterm('ALL') ; {translate_operation_name(Name,TName)},ppterm(TName)),
1873		",",pp_context_state(StateID).
1874		pp_b_context(checking_invariant) --> !,
1875		" ERROR CONTEXT: INVARIANT CHECKING,", pp_cur_context_state.
1876		pp_b_context(checking_negation_of_invariant(State)) --> !,
1877		" ERROR CONTEXT: NEGATION_OF_INVARIANT CHECKING, State:", pp_b_state(State,1000).
1878		pp_b_context(checking_assertions) --> !,
1879		" ERROR CONTEXT: ASSERTION CHECKING,", pp_cur_context_state.
1880		pp_b_context(checking_context(Check,Name)) --> !,
1881		" ERROR CONTEXT: ", ppterm(Check),ppterm(Name).
1882		pp_b_context(loading_context(_FName)) --> !.
1883		pp_b_context(unit_test_context(Module,TotNr,Line,Call)) --> !,
1884		" ERROR CONTEXT: Unit Test ", ppterm(TotNr), " in module ", ppterm(Module),
1885		" at line ", ppterm(Line), " calling ", pp_functor(Call).
1886		pp_b_context(visb_error_context(Class,ID,OpNameOrAttr,Span)) --> !,
1887		" ERROR CONTEXT: VisB ", ppterm(Class), " with ID ", ppterm(ID),
1888		({OpNameOrAttr='all_attributes'} -> ""
1889		; " and attribute/event ", ppterm(OpNameOrAttr)
1890		),
1891		" ", translate_span(Span,only_subsidiary).
1892		pp_b_context(C) --> ppterm(C),pp_cur_context_state.
1893
1894		pp_functor(V) --> {var(V)},!, ppterm(V).
1895		pp_functor(T) --> {functor(T,F,N)}, ppterm(F),"/",ppterm(N).
1896
1897		pp_cur_context_state --> {state_space:get_current_context_state(ID)}, !,pp_context_state(ID).
1898		pp_cur_context_state --> ", unknown context state.".
1899
1900		% assumes we are in the right state:
1901		pp_current_state --> {state_space:current_expression(ID,_)}, !,pp_context_state(ID).
1902		pp_current_state --> ", unknown current context state.".
1903
1904		% TO DO: limit length/size of generated error description
1905		pp_context_state(ID) --> {state_space:visited_expression(ID,State)},!, % we have a state ID
1906		" State ID:", ppterm(ID),
1907		pp_context_state2(State).
1908		pp_context_state(State) --> pp_context_state3(State).
1909
1910		pp_context_state2(_) --> {debug:debug_mode(off)},!.
1911		pp_context_state2(State) --> ",", pp_context_state3(State).
1912
1913		pp_context_state3(State) --> " State: ",pp_any_state_with_limit(State,10).
1914
1915		pp_any_state_with_limit(State,Limit) -->
1916		{ get_preference(expand_avl_upto,CurLim),
1917		(CurLim<0 ; Limit < CurLim),
1918		!,
1919		temporary_set_preference(expand_avl_upto,Limit,CHNG),
1920		VarLimit is Limit*10
1921		},
1922		pp_any_state(State,VarLimit),
1923		{reset_temporary_preference(expand_avl_upto,CHNG)}.
1924		pp_any_state_with_limit(State,_Limit) -->
1925		{get_preference(expand_avl_upto,CurLim), VarLimit is CurLim*10},
1926		pp_any_state(State,VarLimit).
1927
1928		pp_any_state(X,VarLimit) --> try_pp_b_state(X,VarLimit),!.
1929		pp_any_state(csp_and_b(P,B),VarLimit) --> "CSP: ",{pp_csp_process(P,Atoms,[])},!,atoms_to_codelist(Atoms),
1930		" || B: ", try_pp_b_state(B,VarLimit).
1931		pp_any_state(X,_) --> {animation_mode(xtl)}, !, "XTL: ",ppterm(X). % CSP state
1932		pp_any_state(P,_) --> "CSP: ",{pp_csp_process(P,Atoms,[])},!,atoms_to_codelist(Atoms).
1933		pp_any_state(X,_) --> "Other formalism: ",ppterm(X). % CSP state
1934
1935		atoms_to_codelist([]) --> [].
1936		atoms_to_codelist([Atom|T]) --> ppterm(Atom), atoms_to_codelist(T).
1937
1938		% ----------------
1939
1940		:- dynamic deferred_set_constant/3.
1941
1942		set_translation_context(const_and_vars(ConstID,_)) :- !,
1943		%% print_message(setting_translation_constants(ConstID)),
1944		set_translation_constants(ConstID).
1945		set_translation_context(expanded_const_and_vars(ConstID,_,_,_)) :- !,
1946		set_translation_constants(ConstID).
1947		set_translation_context(_).
1948
1949		set_translation_constants(_) :- clear_translation_constants,
1950		get_preference(dot_print_use_constants,false),!.
1951		set_translation_constants(ConstID) :- var(ConstID),!,
1952		add_error(set_translation_constants,'Variable used as ConstID: ',ConstID).
1953		set_translation_constants(ConstID) :-
1954		state_space:visited_expression(ConstID,concrete_constants(ConstantsStore)),!,
1955		%% print_message(setting_constants(ConstID)),%%
1956		(treat_constants(ConstantsStore) -> true ; print_message(fail)).
1957		set_translation_constants(ConstID) :-
1958		add_error(set_translation_constants,'Unknown ConstID: ',ConstID).
1959
1960		clear_translation_constants :- %print_message(clearing),%%
1961		retractall(deferred_set_constant(_,_,_)).
1962
1963		treat_constants([]).
1964		treat_constants([bind(CstName,Val)|T]) :-
1965		((Val=fd(X,GSet),b_global_deferred_set(GSet))
1966		-> (deferred_set_constant(GSet,X,_)
1967		-> true /* duplicate def of value */
1968		; assertz(deferred_set_constant(GSet,X,CstName))
1969		)
1970		; true
1971		),
1972		treat_constants(T).
1973
1974
1975
1976		translate_bvalue_with_tlatype(Value,Type,Output) :-
1977		( pp_tla_value(Type,Value,Codes,[]) ->
1978		atom_codes_with_limit(Output,Codes)
1979		; add_error(translate_bvalue,'Could not translate TLA value: ',Value),
1980		Output='???').
1981
1982		pp_tla_value(function(_Type1,_Type2),[]) --> !,
1983		ppcodes("<<>>").
1984		pp_tla_value(function(integer,T2),avl_set(Set)) -->
1985		{convert_avlset_into_sequence(Set,Seq)}, !,
1986		pp_tla_with_sep("<< "," >>",",",T2,Seq).
1987		pp_tla_value(function(T1,T2),Set) -->
1988		{is_printable_set(Set,Values)},!,
1989		pp_tla_with_sep("(",")"," @@ ",function_value(T1,T2),Values).
1990		pp_tla_value(function_value(T1,T2),(L,R)) -->
1991		!,pp_tla_value(T1,L),":>",pp_tla_value(T2,R).
1992		pp_tla_value(set(Type),Set) -->
1993		{is_printable_set(Set,Values)},!,
1994		pp_tla_with_sep("{","}",",",Type,Values).
1995		pp_tla_value(tuple(Types),Value) -->
1996		{pairs_to_list(Types,Value,Values,[]),!},
1997		pp_tla_with_sep("<< "," >>",",",Types,Values).
1998		pp_tla_value(record(Fields),rec(FieldValues)) -->
1999		% TODO: Check if we can safely assume that Fields and FieldValues have the
2000		% same order
2001		!, {sort_tla_fields(Fields,FieldValues,RFields,RFieldValues)},
2002		pp_tla_with_sep("[","]",", ",RFields,RFieldValues).
2003		pp_tla_value(field(Name,Type),field(_,Value)) -->
2004		!, ppatom_opt_scramble(Name)," |-> ",pp_tla_value(Type,Value).
2005		pp_tla_value(_Type,Value) -->
2006		% fallback: use B's pretty printer
2007		pp_value(Value).
2008
2009		is_printable_set(avl_set(A),List) :- avl_domain(A,List).
2010		is_printable_set([],[]).
2011		is_printable_set([H|T],[H|T]).
2012
2013		pairs_to_list([_],Value) --> !,[Value].
2014		pairs_to_list([_|Rest],(L,R)) -->
2015		pairs_to_list(Rest,L),[R].
2016
2017
2018		sort_tla_fields([],_,[],[]).
2019		sort_tla_fields([Field|RFields],ValueFields,RFieldTypes,ResultValueFields) :-
2020		( Field=field(Name,Type) -> true
2021		; Field= opt(Name,Type) -> true),
2022		( selectchk(field(Name,Value),ValueFields,RestValueFields),
2023		field_value_present(Field,Value,Result) ->
2024		% Found the field in the record value
2025		RFieldTypes = [field(Name,Type) |RestFields],
2026		ResultValueFields = [field(Name,Result)|RestValues],
2027		sort_tla_fields(RFields,RestValueFields,RestFields,RestValues)
2028		;
2029		% didn't found the field in the value -> igore
2030		sort_tla_fields(RFields,ValueFields,RFieldTypes,ResultValueFields)
2031		).
2032		field_value_present(field(_,_),RecValue,RecValue). % Obligatory fields are always present
2033		field_value_present(opt(_,_),OptValue,Value) :-
2034		% Optional fields are present if the field is of the form TRUE |-> Value.
2035		( is_printable_set(OptValue,Values) -> Values=[(_TRUE,Value)]
2036		;
2037		add_error(translate,'exptected set for TLA optional record field'),
2038		fail
2039		).
2040
2041		pp_tla_with_sep(Start,End,Sep,Type,Values) -->
2042		ppcodes(Start),pp_tla_with_sep_aux(Values,End,Sep,Type).
2043		pp_tla_with_sep_aux([],End,_Sep,_Type) -->
2044		ppcodes(End).
2045		pp_tla_with_sep_aux([Value|Rest],End,Sep,Type) -->
2046		% If a single type is given, we interpret it as the type
2047		% for each element of the list, if it is a list, we interpret
2048		% it one different type for every value in the list.
2049		{ (Type=[CurrentType|RestTypes] -> true ; CurrentType = Type, RestTypes=Type) },
2050		pp_tla_value(CurrentType,Value),
2051		( {Rest=[_|_]} -> ppcodes(Sep); {true} ),
2052		pp_tla_with_sep_aux(Rest,End,Sep,RestTypes).
2053
2054
2055		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2056		% pretty-print a value
2057
2058		translate_bvalue_for_dot(string(S),Translation) :- !,
2059		% normal quotes confuse dot
2060		%ajoin(['''''',S,''''''],Translation).
2061		string_escape(S,ES),
2062		ajoin(['\\"',ES,'\\"'],Translation).
2063		translate_bvalue_for_dot(Val,ETranslation) :-
2064		translate_bvalue(Val,Translation),
2065		string_escape(Translation,ETranslation).
2066
2067		translate_bvalue_to_codes(V,Output) :-
2068		( pp_value(V,_LimitReached,Codes,[]) ->
2069		Output=Codes
2070		; add_error(translate_bvalue_to_codes,'Could not translate bvalue: ',V),
2071		Output="???").
2072		translate_bvalue_to_codes_with_limit(V,Limit,Output) :-
2073		set_up_limit_reached(Codes,Limit,LimitReached), % TODO: also limit expand_avl_upto
2074		( pp_value(V,LimitReached,Codes,[]) ->
2075		Output=Codes
2076		; add_error(translate_bvalue_to_codes,'Could not translate bvalue: ',V),
2077		Output="???").
2078
2079		translate_bvalue(V,Output) :-
2080		%set_up_limit_reached(Codes,1000000,LimitReached), % we could set a very high-limit, like max_atom_length
2081		( pp_value(V,_LimitReached,Codes,[]) ->
2082		atom_codes_with_limit(Output,Codes) % just catches representation error
2083		; add_error(translate_bvalue,'Could not translate bvalue: ',V),
2084		Output='???').
2085		:- use_module(preferences).
2086		translate_bvalue_with_limit(V,Limit,Output) :-
2087		get_preference(expand_avl_upto,Max),
2088		((Max > Limit % no sense in printing larger AVL trees
2089		; (Max < 0, Limit >= 0)) % or setting limit to -1 for full value
2090		-> temporary_set_preference(expand_avl_upto,Limit,CHNG)
2091		; CHNG=false),
2092		call_cleanup(translate_bvalue_with_limit_aux(V,Limit,Output),
2093		reset_temporary_preference(expand_avl_upto,CHNG)).
2094		translate_bvalue_with_limit_aux(V,Limit,OutputAtom) :-
2095		set_up_limit_reached(Codes,Limit,LimitReached),
2096		( pp_value(V,LimitReached,Codes,[]) ->
2097		atom_codes_with_limit(OutputAtom,Limit,Codes)
2098		% ,length(Codes,Len), (Len>Limit -> format('pp(~w) codes:~w, limit:~w, String=~s~n~n',[LimitReached,Len,Limit,Codes]) ; true)
2099		; add_error(translate_bvalue_with_limit,'Could not translate bvalue: ',V),
2100		OutputAtom='???').
2101
2102		translate_bvalues(Values,Output) :-
2103		translate_bvalues_with_limit(Values,no_limit,Output). % we could set a very high-limit, like max_atom_length
2104
2105		translate_bvalues_with_limit(Values,Limit,Output) :-
2106		(Limit==no_limit -> true %
2107		; set_up_limit_reached(Codes,Limit,LimitReached)
2108		),
2109		pp_value_l(Values,',',LimitReached,Codes,[]),!,
2110		atom_codes_with_limit(Output,Codes).
2111		translate_bvalues_with_limit(Values,Limit,O) :-
2112		add_internal_error('Call failed: ',translate_bvalues(Values,Limit,O)), O='??'.
2113
2114		translate_bvalue_for_expression(Value,TExpr,Output) :-
2115		animation_minor_mode(tla),
2116		expression_has_tla_type(TExpr,TlaType),!,
2117		translate_bvalue_with_tlatype(Value,TlaType,Output).
2118		translate_bvalue_for_expression(Value,TExpr,Output) :-
2119		get_texpr_type(TExpr,Type),
2120		translate_bvalue_with_type(Value,Type,Output).
2121
2122		translate_bvalue_for_expression_with_limit(Value,TExpr,_Limit,Output) :-
2123		animation_minor_mode(tla),
2124		expression_has_tla_type(TExpr,TlaType),!,
2125		translate_bvalue_with_tlatype(Value,TlaType,Output). % TO DO: treat Limit
2126		translate_bvalue_for_expression_with_limit(Value,TExpr,Limit,Output) :-
2127		get_texpr_type(TExpr,Type),
2128		translate_bvalue_with_type_and_limit(Value,Type,Limit,Output).
2129
2130		expression_has_tla_type(TExpr,Type) :-
2131		get_texpr_info(TExpr,Infos),
2132		memberchk(tla_type(Type),Infos).
2133
2134
2135		translate_bvalue_to_parseable_classicalb(Val,Str) :-
2136		% corresponds to set_print_type_infos(needed)
2137		temporary_set_preference(translate_force_all_typing_infos,false,CHNG),
2138		temporary_set_preference(translate_print_typing_infos,true,CHNG2),
2139		(animation_minor_mode(X)
2140		-> remove_animation_minor_mode,
2141		call_cleanup(translate_bvalue_to_parseable_aux(Val,Str),
2142		(reset_temporary_preference(translate_force_all_typing_infos,CHNG),
2143		reset_temporary_preference(translate_print_typing_infos,CHNG2),
2144		set_animation_minor_mode(X)))
2145		; call_cleanup(translate_bvalue_to_parseable_aux(Val,Str),
2146		(reset_temporary_preference(translate_force_all_typing_infos,CHNG),
2147		reset_temporary_preference(translate_print_typing_infos,CHNG2)))
2148		).
2149		translate_bvalue_to_parseable_aux(Val,Str) :-
2150		call_pp_with_no_limit_and_parseable(translate_bvalue(Val,Str)).
2151
2152
2153		translate_bexpr_to_parseable(Expr,Str) :-
2154		call_pp_with_no_limit_and_parseable(translate_bexpression(Expr,Str)).
2155
2156		% a more refined pretty printing: takes Type information into account; useful for detecting sequences
2157		translate_bvalue_with_type(Value,_,Output) :- var(Value),!,
2158		translate_bvalue(Value,Output).
2159		translate_bvalue_with_type(Value,Type,Output) :-
2160		adapt_value_according_to_type(Type,Value,NewValue),
2161		translate_bvalue(NewValue,Output).
2162
2163		translate_bvalue_with_type_and_limit(Value,Type,Limit,Output) :-
2164		(Limit < 0 -> SetLim = -1 ; SetLim is Limit//2), % at least two symbols per element
2165		get_preference(expand_avl_upto,CurLim),
2166		((CurLim < 0, SetLim >= 0) ; SetLim < CurLim),!,
2167		temporary_set_preference(expand_avl_upto,SetLim,CHNG),
2168		translate_bvalue_with_type_and_limit2(Value,Type,Limit,Output),
2169		reset_temporary_preference(expand_avl_upto,CHNG).
2170		translate_bvalue_with_type_and_limit(Value,Type,Limit,Output) :-
2171		translate_bvalue_with_type_and_limit2(Value,Type,Limit,Output).
2172		translate_bvalue_with_type_and_limit2(Value,_,Limit,Output) :- var(Value),!,
2173		translate_bvalue_with_limit(Value,Limit,Output).
2174		translate_bvalue_with_type_and_limit2(Value,Type,Limit,Output) :-
2175		adapt_value_according_to_type(Type,Value,NewValue),
2176		translate:translate_bvalue_with_limit(NewValue,Limit,Output).
2177		%debug:watch(translate:translate_bvalue_with_limit(NewValue,Limit,Output)).
2178
2179		:- use_module(avl_tools,[quick_avl_approximate_size/2]).
2180		adapt_value_according_to_type(_,Var,R) :- var(Var),!,R=Var.
2181		adapt_value_according_to_type(T,V,R) :- var(T),!,
2182		add_internal_error('Variable type: ',adapt_value_according_to_type(T,V,R)),
2183		R=V.
2184		adapt_value_according_to_type(integer,V,R) :- !,R=V.
2185		adapt_value_according_to_type(string,V,R) :- !,R=V.
2186		adapt_value_according_to_type(boolean,V,R) :- !,R=V.
2187		adapt_value_according_to_type(global(_),V,R) :- !,R=V.
2188		adapt_value_according_to_type(couple(TA,TB),(VA,VB),R) :- !, R=(RA,RB),
2189		adapt_value_according_to_type(TA,VA,RA),
2190		adapt_value_according_to_type(TB,VB,RB).
2191		adapt_value_according_to_type(set(Type),avl_set(A),Res) :- check_is_non_empty_avl(A),
2192		quick_avl_approximate_size(A,S),S<20,
2193		custom_explicit_sets:expand_custom_set_to_list(avl_set(A),List),!,
2194		maplist(adapt_value_according_to_type(Type),List,Res).
2195		adapt_value_according_to_type(set(_Type),V,R) :- !,R=V.
2196		adapt_value_according_to_type(seq(Type),V,R) :- !, % the type tells us it is a sequence
2197		(convert_set_into_sequence(V,VS)
2198		-> l_adapt_value_according_to_type(VS,Type,AVS),
2199		R=sequence(AVS)
2200		; R=V).
2201		adapt_value_according_to_type(record(Fields),rec(Values),R) :- !,
2202		R=rec(AdaptedValues),
2203		% fields and values should be in the same (alphabetical) order
2204		maplist(adapt_record_field_according_to_type,Fields,Values,AdaptedValues).
2205		adapt_value_according_to_type(freetype(_),Value,R) :-
2206		Value = freeval(ID,_,term(ID)), % not a constructor, just a value
2207		!,
2208		R = Value.
2209		adapt_value_according_to_type(freetype(_),freeval(ID,Case,SubValue),R) :-
2210		!,
2211		R = freeval(ID,Case,AdaptedSubValue),
2212		kernel_freetypes:get_freeval_type(ID,Case,SubType),
2213		adapt_value_according_to_type(SubType,SubValue,AdaptedSubValue).
2214		adapt_value_according_to_type(any,Value,R) :- !, R=Value.
2215		adapt_value_according_to_type(pred,Value,R) :- !, R=Value.
2216		adapt_value_according_to_type(_,term(V),R) :- !, R=term(V). % appears for unknown values (no_value_for) when ALLOW_INCOMPLETE_SETUP_CONSTANTS is true
2217		adapt_value_according_to_type(Type,Value,R) :- print(adapt_value_according_to_type_unknown(Type,Value)),nl,
2218		R=Value.
2219
2220		l_adapt_value_according_to_type([],_Type,R) :- !,R=[].
2221		l_adapt_value_according_to_type([H|T],Type,[AH|AT]) :-
2222		adapt_value_according_to_type(Type,H,AH),
2223		l_adapt_value_according_to_type(T,Type,AT).
2224
2225		adapt_record_field_according_to_type(field(Name,HTy),field(Name,H),field(Name,R)) :-
2226		adapt_value_according_to_type(HTy,H,R).
2227
2228
2229		pp_value_with_type(E,T,LimitReached) --> {adapt_value_according_to_type(T,E,AdaptedE)},
2230		pp_value(AdaptedE,LimitReached).
2231
2232		pp_value(V,In,Out) :-
2233		set_up_limit_reached(In,1000,LimitReached),
2234		pp_value(V,LimitReached,In,Out).
2235
2236		% LimitReached is a flag: when it is grounded to limit_reached this instructs pp_value to stop generating output
2237		pp_value(_,LimitReached) --> {LimitReached==limit_reached},!, "...".
2238		pp_value(V,_) --> {var(V)},!, pp_variable(V).
2239		pp_value('$VAR'(N),_) --> !,pp_numberedvar(N).
2240		pp_value(X,_) --> {cyclic_term(X)},!,underscore_symbol,"cyclic",underscore_symbol.
2241		pp_value(fd(X,GSet),_) --> {var(X)},!,
2242		ppatom(GSet),":", ppnumber(X). %":??".
2243		pp_value(fd(X,GSet),_) -->
2244		{b_global_sets:is_b_global_constant_hash(GSet,X,Res)},!,
2245		pp_identifier(Res).
2246		pp_value(fd(X,GSet),_) --> {deferred_set_constant(GSet,X,Cst)},!,
2247		pp_identifier(Cst).
2248		pp_value(fd(X,M),_) --> !,ppatom_opt_scramble(M),ppnumber(X).
2249		pp_value(int(X),_) --> !,ppnumber(X).
2250		pp_value(term(floating(X)),_) --> !,ppnumber(X).
2251		pp_value(string(X),_) --> !,string_start_symbol,ppstring_opt_scramble(X),string_end_symbol.
2252		pp_value(global_set(X),_) --> {atomic(X),integer_set_mapping(X,Kind,Y)},!,
2253		({Kind=integer_set} -> ppatom(Y) ; ppatom_opt_scramble(X)).
2254		pp_value(term(X),_) --> {var(X)},!,"term(",pp_variable(X),")".
2255		pp_value(freetype(X),_) --> {pretty_freetype(X,P)},!,ppatom_opt_scramble(P).
2256		pp_value(pred_true /* bool_true */,_) --> %!,"TRUE". % TO DO: in latex_mode: surround by mathit
2257		{constants_in_mode(pred_true,Symbol)},!,ppatom(Symbol).
2258		pp_value(pred_false /* bool_false */,_) --> %!,"FALSE".
2259		{constants_in_mode(pred_false,Symbol)},!,ppatom(Symbol).
2260		%pp_value(bool_true) --> !,"TRUE". % old version; still in some test traces which are printed
2261		%pp_value(bool_false) --> !,"FALSE".
2262		pp_value([],_) --> !,empty_set_symbol.
2263		pp_value(sequence(List),LimitReached) --> !,
2264		({List=[]} -> pp_empty_sequence ; pp_sequence_with_limit(List,LimitReached)).
2265		pp_value([Head|Tail],LimitReached) --> {get_preference(translate_print_all_sequences,true),
2266		convert_set_into_sequence([Head|Tail],Elements)},
2267		!,
2268		pp_sequence(Elements,LimitReached).
2269		pp_value([Head|Tail],LimitReached) --> !, {set_brackets(L,R)},
2270		ppatom(L),
2271		pp_value_l_with_limit([Head|Tail],',',LimitReached),
2272		ppatom(R).
2273		%pp_value([Head|Tail]) --> !,
2274		% {( convert_set_into_sequence([Head|Tail],Elements) ->
2275		% (Start,End) = ('[',']')
2276		% ;
2277		% Elements = [Head|Tail],
2278		% (Start,End) = ('{','}'))},
2279		% ppatom(Start),pp_value_l(Elements,','),ppatom(End).
2280		pp_value( (A,B) ,LimitReached) --> !,
2281		"(",pp_inner_value(A,LimitReached),
2282		maplet_symbol,
2283		pp_value(B,LimitReached),")".
2284		pp_value(avl_set(A),LimitReached) --> !,
2285		{check_is_non_empty_avl(A),avl_size(A,Sz)},
2286		{set_brackets(LBrace,RBrace)},
2287		( {size_is_in_set_limit(Sz),
2288		%(Sz>2 ; get_preference(translate_print_all_sequences,true)),
2289		get_preference(translate_print_all_sequences,true), % no longer try and convert any sequence longer than 2 to sequence notation
2290		avl_max(A,(int(Sz),_)), % a sequence has minimum int(1) and maximum int(Sz)
2291		convert_avlset_into_sequence(A,Seq)} ->
2292		pp_sequence(Seq,LimitReached)
2293		;
2294		( {Sz=0} -> left_set_bracket," /* empty avl_set */ ",right_set_bracket
2295		; {(size_is_in_set_limit(Sz) ; Sz < 3)} -> % if Sz 3 we will print at least two elements anyway
2296		{avl_domain(A,List)},
2297		ppatom(LBrace),pp_value_l(List,',',LimitReached),ppatom(RBrace)
2298		; {(Sz<5 ; \+ size_is_in_set_limit(4))} ->
2299		{avl_min(A,Min),avl_max(A,Max)},
2300		hash_card_symbol, % "#"
2301		ppnumber(Sz),":", left_set_bracket,
2302		pp_value(Min,LimitReached),",",ldots,",",pp_value(Max,LimitReached),right_set_bracket
2303		;
2304		{avl_min(A,Min),avl_next(Min,A,Nxt),avl_max(A,Max),avl_prev(Max,A,Prev)},
2305		hash_card_symbol, % "#",
2306		ppnumber(Sz),":", left_set_bracket,
2307		pp_value(Min,LimitReached),",",pp_value(Nxt,LimitReached),",",ldots,",",
2308		pp_value(Prev,LimitReached),",",pp_value(Max,LimitReached),right_set_bracket )).
2309
2310		pp_value(field(Name,Value),LimitReached) --> !,
2311		pp_identifier(Name),":",pp_value(Value,LimitReached). % : for fields has priority 120 in French manual
2312		pp_value(rec(Rec),LimitReached) --> !,
2313		{function_like_in_mode(rec,Symbol)},
2314		ppatom(Symbol), "(",pp_value_l(Rec,',',LimitReached),")".
2315		pp_value(struct(Rec),LimitReached) --> !,
2316		{function_like_in_mode(struct,Symbol)},
2317		ppatom(Symbol), "(", pp_value_l(Rec,',',LimitReached),")".
2318		pp_value(term(no_value_for(Id)),_) --> !,
2319		"undefined ",ppatom(Id).
2320		pp_value(closure(Variables,Types,Predicate),LimitReached) --> !,
2321		pp_closure_value(Variables,Types,Predicate,LimitReached).
2322		pp_value(freeval(Freetype,Case,Value),LimitReached) --> !,
2323		({ground(Case),ground(Value),Value=term(Case)} -> ppatom_opt_scramble(Case)
2324		; {ground(Case)} -> ppatom_opt_scramble(Case),"(",pp_value(Value,LimitReached),")"
2325		; {pretty_freetype(Freetype,P)},
2326		"FREEVALUE[",ppatom_opt_scramble(P),
2327		",",write_to_codes(Case),
2328		"](",pp_value(Value,LimitReached),")"
2329		).
2330		pp_value(X,_) --> {animation_mode(xtl)},!,
2331		write_to_codes(X).
2332		pp_value(X,_) --> % the << >> pose problems when checking against FDR
2333		"<< ",write_to_codes(X)," >>".
2334
2335		pp_variable(V) --> write_to_codes(V). %underscore_symbol.
2336
2337		:- use_module(closures,[is_recursive_closure/3]).
2338
2339		pp_closure_value(Ids,Type,B,_LimitReached) -->
2340		{var(Ids) ; var(Type) ; var(B)},!,
2341		add_internal_error('Illegal value: ',pp_value_illegal_closure(Ids,Type,B)),
2342		"<< ILLEGAL ",write_to_codes(closure(Ids,Type,B))," >>".
2343		pp_closure_value(Variables,Types,Predicate,LimitReached) --> {\+ size_is_in_set_limit(1)},
2344		!, % do not print body; just print hash value
2345		{make_closure_ids(Variables,Types,Ids), term_hash(Predicate,PH)},
2346		left_set_bracket, % { Ids | #PREDICATE#(HASH) }
2347		pp_expr_l_pair_in_mode(Ids,LimitReached),
2348		pp_such_that_bar,
2349		" ",hash_card_symbol,"PREDICATE",hash_card_symbol,"(",ppnumber(PH),") ", right_set_bracket.
2350		pp_closure_value(Variables,Types,Predicate,LimitReached) -->
2351		{get_preference(translate_ids_to_parseable_format,true),
2352		is_recursive_closure(Variables,Types,Predicate),
2353		get_texpr_info(Predicate,Infos),
2354		member(prob_annotation(recursive(TID)),Infos),
2355		def_get_texpr_id(TID,ID)}, !,
2356		% write recursive let for f as : CHOOSE(.) or MU({f|f= SET /*@desc letrec */ })
2357		% an alternate syntax could be RECLET f BE f = SET IN f END
2358		"MU({", pp_identifier(ID), "|",
2359		pp_identifier(ID)," = ",
2360		pp_closure_value2(Variables,Types,Predicate,LimitReached),
2361		"/*@desc letrec */ }) ".
2362		pp_closure_value([Id],[Type],Membership,LimitReached) -->
2363		{ get_texpr_expr(Membership,member(Elem,Set)),
2364		get_texpr_id(Elem,Id),
2365		\+ occurs_in_expr(Id,Set), % detect things like {s|s : 1 .. card(s) --> T} (test 1030)
2366		get_texpr_type(Elem,Type),
2367		!},
2368		pp_expr_m(Set,299,LimitReached).
2369		pp_closure_value(Variables,Types,Predicate,LimitReached) --> pp_closure_value2(Variables,Types,Predicate,LimitReached).
2370
2371		pp_closure_value2(Variables,Types,Predicate,LimitReached) --> !,
2372		{make_closure_ids(Variables,Types,Ids)},
2373		pp_comprehension_set(Ids,Predicate,[],LimitReached). % TODO: propagate LimitReached
2374
2375		% avoid printing parentheses:
2376		% (x,y,z) = ((x,y),z)
2377		pp_inner_value( AB , LimitReached) --> {nonvar(AB),AB=(A,B)}, !, % do not print parentheses in this context
2378		pp_inner_value(A,LimitReached),maplet_symbol,
2379		pp_value(B,LimitReached).
2380		pp_inner_value( Value , LimitReached) --> pp_value( Value , LimitReached).
2381
2382		size_is_in_set_limit(Size) :- get_preference(expand_avl_upto,Max),
2383		(Max<0 -> true /* no limit */
2384		; Size =< Max).
2385
2386		dcg_set_up_limit_reached(Limit,LimitReached,InList,InList) :- set_up_limit_reached(InList,Limit,LimitReached).
2387
2388		% instantiate LimitReached argument as soon as a list exceeds a certain limit
2389		set_up_limit_reached(_,Neg,_) :- Neg<0,!. % negative number means unlimited
2390		set_up_limit_reached(_,0,LimitReached) :- !, LimitReached = limit_reached.
2391		set_up_limit_reached(List,Limit,LimitReached) :-
2392		block_set_up_limit_reached(List,Limit,LimitReached).
2393		:- block block_set_up_limit_reached(-,?,?).
2394		block_set_up_limit_reached([],_,_).
2395		block_set_up_limit_reached([_|T],Limit,LimitReached) :-
2396		(Limit<1 -> LimitReached=limit_reached
2397		; L1 is Limit-1, block_set_up_limit_reached(T,L1,LimitReached)).
2398
2399		% pretty print LimitReached, requires %:- block block_set_up_limit_reached(-,?,-).
2400		/*
2401		pp_lr(LR) --> {LR==limit_reached},!, " *LR* ".
2402		pp_lr(LR) --> {frozen(LR,translate:block_set_up_limit_reached(_,Lim,_))},!, " ok(", ppnumber(Lim),") ".
2403		pp_lr(LR) --> {frozen(LR,G)},!, " ok(", ppterm(G),") ".
2404		pp_lr(_) --> " ok ".
2405		*/
2406
2407
2408		pp_value_l_with_limit(V,Sep,LimitReached) --> {get_preference(expand_avl_upto,Max)},
2409		pp_value_l(V,Sep,Max,LimitReached).
2410		pp_value_l(V,Sep,LimitReached) --> pp_value_l(V,Sep,-1,LimitReached).
2411
2412		pp_value_l(V,_Sep,_,_) --> {var(V)},!,"...".
2413		pp_value_l(_,_,_,LimitReached) --> {LimitReached==limit_reached},!,"...".
2414		pp_value_l('$VAR'(N),_Sep,_,_) --> !,"}\\/{",pp_numberedvar(N),"}".
2415		pp_value_l([],_Sep,_,_) --> !.
2416		pp_value_l([Expr|Rest],Sep,Limit,LimitReached) -->
2417		( {nonvar(Rest),Rest=[]} ->
2418		pp_value(Expr,LimitReached)
2419		; {Limit=0} -> "..."
2420		;
2421		pp_value(Expr,LimitReached),
2422		% no separator for closure special case
2423		({nonvar(Rest) , Rest = closure(_,_,_)} -> {true} ; ppatom(Sep)) ,
2424		{L1 is Limit-1} ,
2425		% convert avl_set(_) in a list's tail to a Prolog list
2426		{nonvar(Rest) , Rest = avl_set(_) -> custom_explicit_sets:expand_custom_set_to_list(Rest,LRest) ; LRest = Rest} ,
2427		pp_value_l(LRest,Sep,L1,LimitReached)).
2428		pp_value_l(avl_set(A),_Sep,_,LimitReached) --> pp_value(avl_set(A),LimitReached).
2429		pp_value_l(closure(A,B,C),_Sep,_,LimitReached) --> "}\\/", pp_value(closure(A,B,C),LimitReached).
2430
2431		make_closure_ids([],[],[]).
2432		make_closure_ids([V|Vrest],[T|Trest],[TExpr|TErest]) :-
2433		(var(V) -> V2='_', format('Illegal variable identifier in make_closure_ids: ~w~n',[V])
2434		; V2=V),
2435		create_texpr(identifier(V2),T,[],TExpr),
2436		make_closure_ids(Vrest,Trest,TErest).
2437
2438		% symbol for starting and ending a sequence:
2439		pp_begin_sequence --> {animation_minor_mode(tla)},!,"<<".
2440		pp_begin_sequence --> {get_preference(translate_print_cs_style_sequences,true)},!,"".
2441		pp_begin_sequence --> "[".
2442		pp_end_sequence --> {animation_minor_mode(tla)},!,">>".
2443		pp_end_sequence --> {get_preference(translate_print_cs_style_sequences,true)},!,"".
2444		pp_end_sequence --> "]".
2445
2446		pp_separator_sequence('') :- get_preference(translate_print_cs_style_sequences,true),!.
2447		pp_separator_sequence(',').
2448
2449		% string for empty sequence
2450		pp_empty_sequence --> {animation_minor_mode(tla)},!, "<< >>".
2451		pp_empty_sequence --> {get_preference(translate_print_cs_style_sequences,true)},!,
2452		( {latex_mode} -> "\\lambda" ; [955]). % 955 is lambda symbol in Unicode
2453		pp_empty_sequence --> {atelierb_mode(prover(_))},!, "{}".
2454		pp_empty_sequence --> "[]".
2455
2456		% symbols for function application:
2457		pp_function_left_bracket --> {animation_minor_mode(tla)},!, "[".
2458		pp_function_left_bracket --> "(".
2459
2460		pp_function_right_bracket --> {animation_minor_mode(tla)},!, "]".
2461		pp_function_right_bracket --> ")".
2462
2463		pp_sequence(Elements,LimitReached) --> {pp_separator_sequence(Sep)},
2464		pp_begin_sequence,
2465		pp_value_l(Elements,Sep,LimitReached),
2466		pp_end_sequence.
2467		pp_sequence_with_limit(Elements,LimitReached) --> {pp_separator_sequence(Sep)},
2468		pp_begin_sequence,
2469		pp_value_l_with_limit(Elements,Sep,LimitReached),
2470		pp_end_sequence.
2471
2472		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2473		% machines
2474
2475		:- use_module(eventhandling,[register_event_listener/3]).
2476		:- register_event_listener(clear_specification,reset_translate,
2477		'Reset Translation Caches.').
2478		reset_translate :- retractall(bugly_scramble_id_cache(_,_)), retractall(non_det_constants(_,_)).
2479		%reset_translate :- set_print_type_infos(none),
2480		% set_preference(translate_suppress_rodin_positions_flag,false).
2481
2482		suppress_rodin_positions(CHNG) :- set_suppress_rodin_positions(true,CHNG).
2483		set_suppress_rodin_positions(Value,CHNG) :-
2484		temporary_set_preference(translate_suppress_rodin_positions_flag,Value,CHNG).
2485		reset_suppress_rodin_positions(CHNG) :-
2486		reset_temporary_preference(translate_suppress_rodin_positions_flag,CHNG).
2487
2488		set_print_type_infos(none) :- !,
2489		set_preference(translate_force_all_typing_infos,false),
2490		set_preference(translate_print_typing_infos,false).
2491		set_print_type_infos(needed) :- !,
2492		set_preference(translate_force_all_typing_infos,false),
2493		set_preference(translate_print_typing_infos,true).
2494		set_print_type_infos(all) :- !,
2495		set_preference(translate_force_all_typing_infos,true),
2496		set_preference(translate_print_typing_infos,true).
2497		set_print_type_infos(Err) :-
2498		add_internal_error('Illegal typing setting: ',set_print_type_infos(Err)).
2499
2500		type_info_setting(none,false,false).
2501		type_info_setting(needed,false,true).
2502		type_info_setting(all,true,true).
2503
2504		set_print_type_infos(Setting,[CHNG1,CHNG2]) :-
2505		type_info_setting(Setting,Value1,Value2),!,
2506		temporary_set_preference(translate_force_all_typing_infos,Value1,CHNG1),
2507		temporary_set_preference(translate_print_typing_infos,Value2,CHNG2).
2508		set_print_type_infos(Err,_) :-
2509		add_internal_error('Illegal typing setting: ',set_print_type_infos(Err,_)),fail.
2510		reset_print_type_infos([CHNG1,CHNG2]) :-
2511		reset_temporary_preference(translate_force_all_typing_infos,CHNG1),
2512		reset_temporary_preference(translate_print_typing_infos,CHNG2).
2513
2514		:- use_module(tools_files,[put_codes/2]).
2515		print_machine(M) :-
2516		nl, translate_machine(M,Msg,true), put_codes(Msg,user_output), nl,
2517		flush_output(user_output),!.
2518		print_machine(M) :- add_internal_error('Printing failed: ',print_machine(M)).
2519
2520		%
2521		translate_machine(M,Codes,AdditionalInfo) :-
2522		retractall(print_additional_machine_info),
2523		(AdditionalInfo=true -> assertz(print_additional_machine_info) ; true),
2524		call_pp_with_no_limit_and_parseable(translate_machine1(M,(0,Codes),(_,[]))).
2525
2526		% perform a call by forcing parseable output and removing limit to set
2527		call_pp_with_no_limit_and_parseable(PP_Call) :-
2528		temporary_set_preference(translate_ids_to_parseable_format,true,CHNG),
2529		temporary_set_preference(expand_avl_upto,-1,CHNG2),
2530		call_cleanup(call(PP_Call),
2531		(reset_temporary_preference(translate_ids_to_parseable_format,CHNG),
2532		reset_temporary_preference(expand_avl_upto,CHNG2))).
2533
2534
2535		% useful if we wish to translate just a selection of sections without MACHINE/END
2536		translate_section_list(SL,Codes) :- init_machine_translation,
2537		translate_machine2(SL,SL,no_end,(0,Codes),(_,[])).
2538
2539		translate_machine1(machine(Name,Sections)) -->
2540		indent('MACHINE '), {adapt_machine_name(Name,AName)}, insertstr(AName),
2541		{init_machine_translation},
2542		translate_machine2(Sections,Sections,end).
2543		translate_machine2([],_,end) --> !, insertstr('\nEND\n').
2544		translate_machine2([],_,_) --> !, insertstr('\n').
2545		translate_machine2([P|Rest],All,End) -->
2546		translate_mpart(P,All),
2547		translate_machine2(Rest,All,End).
2548
2549		adapt_machine_name('dummy(uses)',R) :- !,R='MAIN'.
2550		adapt_machine_name(X,X).
2551
2552		:- dynamic section_header_generated/1.
2553		:- dynamic print_additional_machine_info/0.
2554		print_additional_machine_info.
2555
2556		init_machine_translation :- retractall(section_header_generated(_)).
2557
2558		% start a part of a section
2559		mpstart(Title,I) -->
2560		insertstr('\n'),insertstr(Title),
2561		indention_level(I,I2), {I2 is I+2}.
2562		% end a part of a section
2563		mpend(I) -->
2564		indention_level(_,I).
2565
2566		mpstart_section(Section,Title,AltTitle,I,In,Out) :-
2567		(\+ section_header_generated(Section)
2568		-> mpstart(Title,I,In,Out), assertz(section_header_generated(Section))
2569		; mpstart(AltTitle,I,In,Out) /* use alternative title; section header already generated */
2570		).
2571
2572		translate_mpart(Section/I,All) --> %{print(Section),nl},
2573		( {I=[]} -> {true}
2574		; translate_mpart2(Section,I,All) -> {true}
2575		;
2576		insertstr('\nSection '),insertstr(Section),insertstr(': '),
2577		insertstr('<< pretty-print failed >>')
2578		).
2579		translate_mpart2(deferred_sets,I,_) -->
2580		mpstart_section(sets,'SETS /* deferred */',' ; /* deferred */',P),
2581		indent_expr_l_sep(I,';'),mpend(P).
2582		translate_mpart2(enumerated_sets,_I,_) --> []. % these are now pretty printed below
2583		%mpstart('ENUMERATED SETS',P),indent_expr_l_sep(I,';'),mpend(P).
2584		translate_mpart2(enumerated_elements,I,_) --> %{print(enum_els(I)),nl},
2585		{translate_enums(I,[],Res)},
2586		mpstart_section(sets,'SETS /* enumerated */',' ; /* enumerated */',P),
2587		indent_expr_l_sep(Res,';'),mpend(P).
2588		translate_mpart2(parameters,I,_) --> mpstart('PARAMETERS',P),indent_expr_l_sep(I,','),mpend(P).
2589		translate_mpart2(internal_parameters,I,_) --> {print_additional_machine_info},!,
2590		mpstart('/* INTERNAL_PARAMETERS',P),indent_expr_l_sep(I,','),insertstr(' */'),mpend(P).
2591		translate_mpart2(internal_parameters,_I,_) --> [].
2592		translate_mpart2(abstract_variables,I,_) --> mpstart('ABSTRACT_VARIABLES',P),indent_exprs(I),mpend(P).
2593		translate_mpart2(concrete_variables,I,_) --> mpstart('CONCRETE_VARIABLES',P),indent_exprs(I),mpend(P).
2594		translate_mpart2(abstract_constants,I,_) --> mpstart('ABSTRACT_CONSTANTS',P),indent_exprs(I),mpend(P).
2595		translate_mpart2(concrete_constants,I,_) --> mpstart('CONCRETE_CONSTANTS',P),indent_exprs(I),mpend(P).
2596		translate_mpart2(promoted,I,_) --> {print_additional_machine_info},!,
2597		mpstart('/* PROMOTED OPERATIONS',P),indent_expr_l_sep(I,','),insertstr(' */'),mpend(P).
2598		translate_mpart2(promoted,_I,_) --> [].
2599		translate_mpart2(unpromoted,I,_) --> {print_additional_machine_info},!,
2600		mpstart('/* NOT PROMOTED OPERATIONS',P),indent_expr_l_sep(I,','),insertstr(' */'),mpend(P).
2601		translate_mpart2(unpromoted,_I,_) --> [].
2602		translate_mpart2(constraints,I,All) --> mpart_typing(constraints,[parameters],All,I).
2603		translate_mpart2(invariant,I,All) --> mpart_typing(invariant, [abstract_variables,concrete_variables],All,I).
2604		translate_mpart2(linking_invariant,_I,_) --> [].
2605		translate_mpart2(properties,I,All) --> mpart_typing(properties,[abstract_constants,concrete_constants],All,I).
2606		translate_mpart2(assertions,I,_) -->
2607		mpstart_spec_desc(assertions,P),
2608		%indent_expr_l_sep(I,';'),
2609		preds_over_lines(1,'@thm','; ',I),
2610		mpend(P). % TO DO:
2611		translate_mpart2(initialisation,S,_) --> mpstart_spec_desc(initialisation,P),translate_inits(S),mpend(P).
2612		translate_mpart2(definitions,Defs,_) --> {(standard_library_required(Defs,_) ; set_pref_used(Defs))},!,
2613		mpstart('DEFINITIONS',P),
2614		insertstr('\n'),
2615		{findall(Lib,standard_library_required(Defs,Lib),Libs)},
2616		insert_library_usages(Libs),
2617		translate_set_pref_defs(Defs),
2618		mpend(P),
2619		translate_other_defpart(Defs).
2620		translate_mpart2(definitions,Defs,_) --> !, translate_other_defpart(Defs).
2621		translate_mpart2(operation_bodies,Ops,_) --> mpstart_spec_desc(operations,P),translate_ops(Ops),mpend(P).
2622		translate_mpart2(used,Used,_) --> {print_additional_machine_info},!,
2623		mpstart('/* USED',P),translate_used(Used),insertstr(' */'),mpend(P).
2624		translate_mpart2(used,_Used,_) --> [].
2625		translate_mpart2(freetypes,Freetypes,_) -->
2626		mpstart('FREETYPES',P),translate_freetypes(Freetypes),mpend(P).
2627		translate_mpart2(meta,_Infos,_) --> [].
2628		translate_mpart2(operators,Operators,_) -->
2629		insertstr('\n/* Event-B operators:'), % */
2630		indention_level(I,I2), {I2 is I+2},
2631		translate_eventb_operators(Operators),
2632		indention_level(I2,I),
2633		insertstr('\n*/').
2634		translate_mpart2(values,Values,_) -->
2635		mpstart('VALUES',P),indent_expr_l_sep(Values,';'),mpend(P).
2636
2637		indent_exprs(I) --> {force_eventb_rodin_mode},!, indent_expr_l_sep(I,' '). % Event-B Camille style
2638		indent_exprs(I) --> indent_expr_l_sep(I,',').
2639
2640
2641		% Add typing predicates to a predicate
2642		mpart_typing(Title,Section,Sections,PredI) -->
2643		{mpart_typing2(Section,Sections,PredI,PredO)},
2644		( {is_truth(PredO)} -> [] % TO DO: in animation_minor_mode(z) for INVARIANT: force adding typing predicates (translate_print_typing_infos)
2645		;
2646		mpstart_spec_desc(Title,P),
2647		section_pred_over_lines(0,Title,PredO),
2648		mpend(P)).
2649
2650		mpstart_spec_desc(Title,P) --> {get_specification_description(Title,Atom)},!, mpstart(Atom,P).
2651		mpstart_spec_desc(Title,P) --> mpstart(Title,P).
2652
2653		mpart_typing2(Sections,AllSections,PredI,PredO) :-
2654		get_preference(translate_print_typing_infos,true),!,
2655		get_all_ids(Sections,AllSections,Ids),
2656		add_typing_predicates(Ids,PredI,PredO).
2657		mpart_typing2(_Section,_Sections,Pred,Pred).
2658
2659		get_all_ids([],_Sections,[]).
2660		get_all_ids([Section|Srest],Sections,Ids) :-
2661		memberchk(Section/Ids1,Sections),
2662		append(Ids1,Ids2,Ids),
2663		get_all_ids(Srest,Sections,Ids2).
2664
2665		add_optional_typing_predicates(Ids,In,Out) :-
2666		( get_preference(translate_print_typing_infos,true) -> add_typing_predicates(Ids,In,Out)
2667		; is_truth(In) -> add_typing_predicates(Ids,In,Out)
2668		; In=Out).
2669
2670		add_normal_typing_predicates(Ids,In,Out) :- % used to call add_typing_predicates directly
2671		(add_optional_typing_predicates(Ids,In,Out) -> true
2672		; add_internal_error('Failed: ',add_normal_typing_predicates(Ids)), In=Out).
2673
2674		add_typing_predicates([],P,P) :- !.
2675		add_typing_predicates(Ids,Pin,Pout) :-
2676		remove_already_typed_ids(Pin,Ids,UntypedIds),
2677		KeepSeq=false,
2678		generate_typing_predicates(UntypedIds,KeepSeq,Typing),
2679		conjunction_to_list(Pin,Pins),
2680		remove_duplicate_predicates(Typing,Pins,Typing2),
2681		append(Typing2,[Pin],Preds),
2682		conjunct_predicates(Preds,Pout).
2683
2684		remove_already_typed_ids(_TExpr,Ids,Ids) :-
2685		get_preference(translate_force_all_typing_infos,true),!.
2686		remove_already_typed_ids(TExpr,Ids,UntypedIds) :-
2687		get_texpr_expr(TExpr,Expr),!,
2688		remove_already_typed_ids2(Expr,Ids,UntypedIds).
2689		remove_already_typed_ids(TExpr,Ids,Res) :-
2690		add_internal_error('Not a typed expression: ',remove_already_typed_ids(TExpr,Ids,_)),
2691		Res=Ids.
2692		remove_already_typed_ids2(conjunct(A,B),Ids,UntypedIds) :- !,
2693		remove_already_typed_ids(A,Ids,I1),
2694		remove_already_typed_ids(B,I1,UntypedIds).
2695		remove_already_typed_ids2(lazy_let_pred(_,_,A),Ids,UntypedIds) :- !,
2696		remove_already_typed_ids(A,Ids,UntypedIds). % TO DO: check for variable clases with lazy_let ids ???
2697		remove_already_typed_ids2(Expr,Ids,UntypedIds) :-
2698		is_typing_predicate(Expr,Id),
2699		create_texpr(identifier(Id),_,_,TId),
2700		select(TId,Ids,UntypedIds),!.
2701		remove_already_typed_ids2(_,Ids,Ids).
2702		is_typing_predicate(member(A,_),Id) :- get_texpr_id(A,Id).
2703		is_typing_predicate(subset(A,_),Id) :- get_texpr_id(A,Id).
2704		is_typing_predicate(subset_strict(A,_),Id) :- get_texpr_id(A,Id).
2705
2706		remove_duplicate_predicates([],_Old,[]).
2707		remove_duplicate_predicates([Pred|Prest],Old,Result) :-
2708		(is_duplicate_predicate(Pred,Old) -> Result = Rest ; Result = [Pred|Rest]),
2709		remove_duplicate_predicates(Prest,Old,Rest).
2710		is_duplicate_predicate(Pred,List) :-
2711		remove_all_infos(Pred,Pattern),
2712		memberchk(Pattern,List).
2713
2714		:- use_module(typing_tools,[create_type_set/3]).
2715		generate_typing_predicates(TIds,Preds) :-
2716		generate_typing_predicates(TIds,true,Preds).
2717		generate_typing_predicates(TIds,KeepSeq,Preds) :-
2718		maplist(generate_typing_predicate(KeepSeq), TIds, Preds).
2719		generate_typing_predicate(KeepSeq,TId,Pred) :-
2720		get_texpr_type(TId,Type),
2721		remove_all_infos_and_ground(TId,TId2), % clear all infos
2722		(create_type_set(Type,KeepSeq,TSet) -> create_texpr(member(TId2,TSet),pred,[],Pred)
2723		; TId = b(_,any,[raw]) -> is_truth(Pred) % this comes from transform_raw
2724		; add_error(generate_typing_predicate,'Illegal type in identifier: ',Type,TId),
2725		is_truth(Pred)
2726		).
2727
2728
2729
2730
2731		% translate enumerated constant list into enumerate set definition
2732		translate_enums([],Acc,Acc).
2733		translate_enums([EnumCst|T],Acc,Res) :- %get_texpr_id(EnumCst,Id),
2734		get_texpr_type(EnumCst,global(GlobalSet)),
2735		insert_enum_cst(Acc,EnumCst,GlobalSet,Acc2),
2736		translate_enums(T,Acc2,Res).
2737
2738		insert_enum_cst([],ID,Type,[enumerated_set_def(Type,[ID])]).
2739		insert_enum_cst([enumerated_set_def(Type,Lst)|T],ID,Type2,[enumerated_set_def(Type,Lst2)|TT]) :-
2740		(Type=Type2
2741		-> Lst2 = [ID|Lst], TT=T
2742		; Lst2 = Lst, insert_enum_cst(T,ID,Type2,TT)
2743		).
2744
2745		% pretty-print the initialisation section of a machine
2746		translate_inits(Inits) -->
2747		( {is_list_simple(Inits)} ->
2748		translate_inits2(Inits)
2749		;
2750		indention_level(I,I2),{I2 is I+2},
2751		translate_subst_begin_end(Inits),
2752		indention_level(_,I)).
2753		translate_inits2([]) --> !.
2754		translate_inits2([init(Name,Subst)|Rest]) -->
2755		indent('/* '),insertstr(Name),insertstr(': */ '),
2756		translate_subst_begin_end(Subst),
2757		translate_inits2(Rest).
2758
2759		translate_other_defpart(Defs) --> {print_additional_machine_info},!,
2760		mpstart('/* DEFINITIONS',P),translate_defs(Defs),insertstr(' */'),mpend(P).
2761		translate_other_defpart(_) --> [].
2762
2763		% pretty-print the definitions of a machine
2764		translate_defs([]) --> !.
2765		translate_defs([Def|Rest]) --> translate_def(Def),translate_defs(Rest).
2766		translate_def(definition_decl(Name,_DefType,_Pos,_Args,Expr,_Deps)) -->
2767		{dummy_def_body(Name,Expr)},!.
2768		% this is a DEFINITION from a standard library; do not show it
2769		translate_def(definition_decl(Name,DefType,_Pos,Args,Expr,_Deps)) -->
2770		{def_description(DefType,Desc)}, indent(Desc),insertstr(Name),
2771		{transform_raw_list(Args,TArgs)},
2772		translate_op_params(TArgs),
2773		( {show_def_body(Expr)}
2774		-> insertstr(' '),{translate_in_mode(eqeq,'==',EqEqStr)}, insertstr(EqEqStr), insertstr(' '),
2775		{transform_raw(Expr,TExpr)},
2776		(translate_def_body(DefType,TExpr) -> [] ; insertstr('CANNOT PRETTY PRINT'))
2777		; {true}
2778		),
2779		insertstr(';').
2780		def_description(substitution,'SUBSTITUTION ').
2781		def_description(expression,'EXPRESSION ').
2782		def_description(predicate,'PREDICATE ').
2783		translate_def_body(substitution,B) --> translate_subst_begin_end(B).
2784		translate_def_body(expression,B) --> indent_expr(B).
2785		translate_def_body(predicate,B) --> indent_expr(B).
2786
2787		show_def_body(integer(_,_)).
2788		show_def_body(boolean_true(_)).
2789		show_def_body(boolean_false(_)).
2790		% show_def_body(_) % comment in to pretty print all defs
2791
2792		% check if we have a dummy definition body from a ProB Library file for external functions:
2793		dummy_def_body(Name,Expr) :-
2794		functor(Expr,F,_), (F=external_function_call ; F=external_pred_call),
2795		arg(2,Expr,Name).
2796		%external_function_declarations:external_function_library(Name,NrArgs,DefType,_),length(Args,NrArgs)
2797
2798		% utility to print definitions in JSON format for use in a VisB file:
2799		% useful when converting a B DEFINITIONS file for use in Event-B, TLA+,...
2800		:- public print_defs_as_json/0.
2801		print_defs_as_json :-
2802		findall(json([name=string(Name), value=string(BS)]), (
2803		bmachine:b_get_definition_with_pos(Name,expression,_DefPos,_Args,RawExpr,_Deps),
2804		\+ dummy_def_body(Name,RawExpr),
2805		transform_raw(RawExpr,Body),
2806		translate_subst_or_bexpr(Body,BS)
2807		), Defs),
2808		Json = json([svg=string(''), definitions=array(Defs)]),
2809		json_write_stream(Json).
2810
2811	?	set_pref_used(Defs) :- member(definition_decl(Name,_,_,[],_,_),Defs),
2812		(is_set_pref_def_name(Name,_,_) -> true).
2813
2814		is_set_pref_def_name(Name,Pref,CurValAtom) :-
2815		atom_codes(Name,Codes),append("SET_PREF_",RestCodes,Codes),
2816		atom_codes(Pref,RestCodes),
2817		(eclipse_preference(Pref,P) -> get_preference(P,CurVal), translate_pref_val(CurVal,CurValAtom)
2818		; deprecated_eclipse_preference(Pref,_,NewP,Mapping) -> get_preference(NewP,V), member(CurVal/V,Mapping)
2819		; get_preference(Pref,CurVal), translate_pref_val(CurVal,CurValAtom)),
2820		translate_pref_val(CurVal,CurValAtom).
2821		translate_pref_val(true,'TRUE').
2822		translate_pref_val(false,'FALSE').
2823		translate_pref_val(Nr,NrAtom) :- number(Nr),!, number_codes(Nr,C), atom_codes(NrAtom,C).
2824		translate_pref_val(Atom,Atom) :- atom(Atom).
2825
2826		is_set_pref(definition_decl(Name,_,_Pos,[],_Expr,_Deps)) :-
2827		is_set_pref_def_name(Name,_,_).
2828		translate_set_pref_defs(Defs) -->
2829		{include(is_set_pref,Defs,SPDefs),
2830		sort(SPDefs,SortedDefs)},
2831		translate_set_pref_defs1(SortedDefs).
2832		translate_set_pref_defs1([]) --> !.
2833		translate_set_pref_defs1([Def|Rest]) -->
2834		translate_set_pref_def(Def),translate_set_pref_defs1(Rest).
2835		translate_set_pref_def(definition_decl(Name,_,_Pos,[],_Expr,_Deps)) -->
2836		{is_set_pref_def_name(Name,_Pref,CurValAtom)},!,
2837		insertstr(' '),insertstr(Name),
2838		insertstr(' '),
2839		{translate_in_mode(eqeq,'==',EqEqStr)}, insertstr(EqEqStr), insertstr(' '),
2840		insertstr(CurValAtom), % pretty print current value; Expr could be a more complicated non-atomic expression
2841		insertstr(';\n').
2842		translate_set_pref_def(_) --> [].
2843
2844		standard_library_required(Defs,Library) :-
2845	?	member(Decl,Defs),
2846		definition_decl_from_library(Decl,Library).
2847
2848		% TODO: we could also look in the list of loaded files and search for standard libraries
2849		definition_decl_from_library(definition_decl(printf,predicate,_,[_,_],_,_Deps),'LibraryIO.def').
2850		definition_decl_from_library(definition_decl('STRING_IS_DECIMAL',predicate,_,[_],_,_Deps),'LibraryStrings.def').
2851		definition_decl_from_library(definition_decl('SHA_HASH',expression,_,[_],_,_Deps),'LibraryHash.def').
2852		definition_decl_from_library(definition_decl('CHOOSE',expression,_,[_],_,_Deps),'CHOOSE.def').
2853		definition_decl_from_library(definition_decl('SCCS',expression,_,[_],_,_Deps),'SCCS.def').
2854		definition_decl_from_library(definition_decl('SORT',expression,_,[_],_,_Deps),'SORT.def').
2855		definition_decl_from_library(definition_decl('random_element',expression,_,[_],_,_Deps),'LibraryRandom.def').
2856		definition_decl_from_library(definition_decl('SIN',expression,_,[_],_,_Deps),'LibraryMath.def').
2857		definition_decl_from_library(definition_decl('RMUL',expression,_,[_,_],_,_Deps),'LibraryReals.def').
2858		definition_decl_from_library(definition_decl('REGEX_MATCH',predicate,_,[_,_],_,_Deps),'LibraryRegex.def').
2859		definition_decl_from_library(definition_decl('ASSERT_EXPR',expression,_,[_,_,_],_,_Deps),'LibraryProB.def').
2860		definition_decl_from_library(definition_decl('svg_points',expression,_,[_],_,_Deps),'LibrarySVG.def').
2861		definition_decl_from_library(definition_decl('FULL_FILES',expression,_,[_],_,_Deps),'LibraryFiles.def').
2862		definition_decl_from_library(definition_decl('READ_XML_FROM_STRING',expression,_,[_],_,_Deps),'LibraryXML.def').
2863		definition_decl_from_library(definition_decl('READ_CSV',expression,_,[_],_,_Deps),'LibraryCSV.def').
2864
2865		insert_library_usages([]) --> [].
2866		insert_library_usages([Library|T]) -->
2867		insertstr(' "'),insertstr(Library),insertstr('";\n'), % insert inclusion of ProB standard library
2868		insert_library_usages(T).
2869
2870		% ------------- RAW EXPRESSIONS
2871
2872		% try and print raw machine term or parts thereof (e.g. sections)
2873		print_raw_machine_terms(Var) :- var(Var), !,print('VAR !!'),nl.
2874		print_raw_machine_terms([]) :- !.
2875		print_raw_machine_terms([H|T]) :- !,
2876		print_raw_machine_terms(H), print(' '),
2877		print_raw_machine_terms(T).
2878		print_raw_machine_terms(Term) :- raw_machine_term(Term,String,Sub),!,
2879		format('~n~w ',[String]),
2880		print_raw_machine_terms(Sub),nl.
2881		print_raw_machine_terms(expression_definition(A,B,C,D)) :- !,
2882		print_raw_machine_terms(predicate_definition(A,B,C,D)).
2883		print_raw_machine_terms(substitution_definition(A,B,C,D)) :- !,
2884		print_raw_machine_terms(predicate_definition(A,B,C,D)).
2885		print_raw_machine_terms(predicate_definition(_,Name,Paras,RHS)) :-
2886		Paras==[],!,
2887		format('~n ~w == ',[Name]),
2888		print_raw_machine_terms(RHS),nl.
2889		print_raw_machine_terms(predicate_definition(_,Name,Paras,RHS)) :- !,
2890		format('~n ~w(',[Name]),
2891		print_raw_machine_terms_sep(Paras,','),
2892		format(') == ',[]),
2893		print_raw_machine_terms(RHS),nl.
2894		print_raw_machine_terms(operation(_,Name,Return,Paras,RHS)) :- !,
2895		format('~n ',[]),
2896		(Return=[] -> true
2897		; print_raw_machine_terms_sep(Return,','),
2898		format(' <-- ',[])
2899		),
2900		print_raw_machine_terms(Name),
2901		(Paras=[] -> true
2902		; format(' (',[]),
2903		print_raw_machine_terms_sep(Paras,','),
2904		format(')',[])
2905		),
2906		format(' = ',[]),
2907		print_raw_machine_terms(RHS),nl.
2908		print_raw_machine_terms(Term) :- print_raw_bexpr(Term).
2909
2910
2911		print_raw_machine_terms_sep([],_) :- !.
2912		print_raw_machine_terms_sep([H],_) :- !,
2913		print_raw_machine_terms(H).
2914		print_raw_machine_terms_sep([H|T],Sep) :- !,
2915		print_raw_machine_terms(H),print(Sep),print_raw_machine_terms_sep(T,Sep).
2916
2917		raw_machine_term(machine(M),'',M).
2918		raw_machine_term(generated(_,M),'',M).
2919		raw_machine_term(machine_header(_,Name,_Params),Name,[]). % TO DO: treat Params
2920		raw_machine_term(abstract_machine(_,_,Header,M),'MACHINE',[Header,M]).
2921		raw_machine_term(properties(_,P),'PROPERTIES',P).
2922		raw_machine_term(operations(_,P),'OPERATIONS',P).
2923		raw_machine_term(definitions(_,P),'DEFINITIONS',P).
2924		raw_machine_term(constants(_,P),'CONSTANTS',P).
2925		raw_machine_term(variables(_,P),'VARIABLES',P).
2926		raw_machine_term(invariant(_,P),'INVARIANT',P).
2927		raw_machine_term(assertions(_,P),'ASSERTIONS',P).
2928		raw_machine_term(constraints(_,P),'CONSTRAINTS',P).
2929		raw_machine_term(sets(_,P),'SETS',P).
2930		raw_machine_term(deferred_set(_,P),P,[]). % TO DO: enumerated_set ...
2931		%raw_machine_term(identifier(_,P),P,[]).
2932
2933		l_print_raw_bexpr([]).
2934		l_print_raw_bexpr([Raw|T]) :- write(' '),
2935		print_raw_bexpr(Raw),nl, l_print_raw_bexpr(T).
2936
2937		print_raw_bexpr(Raw) :- % a tool (not perfect) to print raw ASTs
2938		transform_raw(Raw,TExpr),!,
2939		print_bexpr_or_subst(TExpr).
2940
2941		translate_raw_bexpr_with_limit(Raw,Limit,TS) :- transform_raw(Raw,TExpr),
2942		translate_subst_or_bexpr_with_limit(TExpr,Limit,TS).
2943
2944		transform_raw_list(Var,Res) :- var(Var),!,
2945		add_internal_error('Var raw expression list:',transform_raw_list(Var,Res)),
2946		Res= [b(identifier('$$VARIABLE_LIST$$'),any,[raw])].
2947		transform_raw_list(Args,TArgs) :- maplist(transform_raw,Args,TArgs).
2948
2949
2950		transform_raw(Var,Res) :- %print(raw(Var)),nl,
2951		var(Var), !, add_internal_error('Var raw expression:',transform_raw(Var,Res)),
2952		Res= b(identifier('$$VARIABLE$$'),any,[raw]).
2953		transform_raw(precondition(_,Pre,Body),Res) :- !, Res= b(precondition(TP,TB),subst,[raw]),
2954		transform_raw(Pre,TP),
2955		transform_raw(Body,TB).
2956		transform_raw(typeof(_,E,_Type),Res) :- !, transform_raw(E,Res). % remove typeof operator; TODO: transform
2957		transform_raw(identifier(_,M),Res) :- !, Res= b(identifier(M),any,[raw]).
2958		transform_raw(integer(_,M),Res) :- !, Res= b(integer(M),integer,[raw]).
2959		% rules from btype_rewrite2:
2960		transform_raw(integer_set(_),Res) :- !, generate_typed_int_set('INTEGER',Res).
2961		transform_raw(natural_set(_),Res) :- !, generate_typed_int_set('NATURAL',Res).
2962		transform_raw(natural1_set(_),Res) :- !, generate_typed_int_set('NATURAL1',Res).
2963		transform_raw(nat_set(_),Res) :- !, generate_typed_int_set('NAT',Res).
2964		transform_raw(nat1_set(_),Res) :- !, generate_typed_int_set('NAT1',Res).
2965		transform_raw(int_set(_),Res) :- !, generate_typed_int_set('INT',Res).
2966		transform_raw(let_expression(_,_Ids,Eq,Body),Res) :- !,
2967		transform_raw(conjunct(_,Eq,Body),Res). % TO DO: fix and generate let_expression(Ids,ListofExprs,Body)
2968		transform_raw(let_predicate(_,_Ids,Eq,Body),Res) :- !,
2969		transform_raw(conjunct(_,Eq,Body),Res). % ditto
2970		transform_raw(forall(_,Ids,Body),Res) :- !,
2971		(Body=implication(_,LHS,RHS) -> true ; LHS=truth,RHS=Body),
2972		transform_raw(forall(_,Ids,LHS,RHS),Res).
2973		transform_raw(record_field(_,Rec,identifier(_,Field)),Res) :- !, Res = b(record_field(TRec,Field),any,[]),
2974		transform_raw(Rec,TRec).
2975		transform_raw(rec_entry(_,identifier(_,Field),Rec),Res) :- !, Res = field(Field,TRec),
2976		transform_raw(Rec,TRec).
2977		transform_raw(conjunct(_,List),Res) :- !,
2978		transform_raw_list_to_conjunct(List,Res). % sometimes conjunct/1 with list is used (e.g., .eventb files)
2979		transform_raw(couple(_,L),Res) :- !, transform_raw_list_to_couple(L,Res). % couples are represented by lists
2980		transform_raw(extended_expr(Pos,Op,L,_TypeParas),Res) :- !,
2981		(L=[] -> transform_raw(identifier(none,Op),Res) % no arguments
2982		; transform_raw(function(Pos,identifier(none,Op),L),Res)).
2983		transform_raw(extended_pred(Pos,Op,L,_TypeParas),Res) :- !,
2984		transform_raw(function(Pos,identifier(none,Op),L),Res). % not of correct type pred, but seems to work
2985		transform_raw(external_function_call_auto(Pos,Name,Para),Res) :- !,
2986		transform_raw(external_function_call(Pos,Name,Para),Res). % we assume expr rather than pred and hope for the best
2987		transform_raw(function(_,F,L),Res) :- !, transform_raw(F,TF),
2988		Res = b(function(TF,Args),any,[]),
2989		transform_raw_list_to_couple(L,Args). % args are represented by lists
2990		transform_raw(Atom,Res) :- atomic(Atom),!,Res=Atom.
2991		transform_raw([H|T],Res) :- !, maplist(transform_raw,[H|T],Res).
2992		transform_raw(Symbolic,Res) :- symbolic_raw(Symbolic,Body),!,
2993		transform_raw(Body,Res).
2994		transform_raw(OtherOp,b(Res,Type,[])) :- OtherOp =..[F,_Pos|Rest],
2995		maplist(transform_raw,Rest,TRest),
2996		(get_type(F,FT) -> Type=FT ; Type=any),
2997		Res =.. [F|TRest].
2998		transform_raw_list_to_couple([R],Res) :- !, transform_raw(R,Res).
2999		transform_raw_list_to_couple([R1|T],Res) :- !, Res=b(couple(TR1,TT),any,[]),
3000		transform_raw(R1,TR1),transform_raw_list_to_couple(T,TT).
3001		transform_raw_list_to_conjunct([R],Res) :- !, transform_raw(R,Res).
3002		transform_raw_list_to_conjunct([R1|T],Res) :- !, Res=b(conjunct(TR1,TT),pred,[]),
3003		transform_raw(R1,TR1),transform_raw_list_to_conjunct(T,TT).
3004		generate_typed_int_set(Name,b(integer_set(Name),set(integer),[])).
3005		get_type(conjunct,pred).
3006		get_type(disjunct,pred).
3007		get_type(implication,pred).
3008		get_type(equivalence,pred).
3009		get_type(member,pred).
3010		get_type(equal,pred).
3011		get_type(not_equal,pred).
3012		get_type(not_member,pred).
3013		get_type(subset,pred).
3014		get_type(not_subset,pred).
3015
3016		symbolic_raw(symbolic_composition(A,B,C),composition(A,B,C)).
3017		symbolic_raw(symbolic_comprehension_set(A,B,C),comprehension_set(A,B,C)).
3018		symbolic_raw(symbolic_event_b_comprehension_set(A,B,C,D),eventb_comprehension_set(A,B,C,D)).
3019		symbolic_raw(symbolic_lambda(A,B,C,D),lambda(A,B,C,D)).
3020		symbolic_raw(symbolic_quantified_union(A,B,C,D),quantified_union(A,B,C,D)).
3021
3022		% -------------
3023
3024
3025		% pretty-print the operations of a machine
3026		translate_ops([]) --> !.
3027		translate_ops([Op|Rest]) -->
3028		translate_op(Op),
3029		({Rest=[]} -> {true}; insertstr(';'),indent),
3030		translate_ops(Rest).
3031		translate_op(Op) -->
3032		{ get_texpr_expr(Op,operation(Id,Res,Params,Body)) },
3033		translate_operation(Id,Res,Params,Body).
3034		translate_operation(Id,Res,Params,Body) -->
3035		indent,translate_op_results(Res),
3036		pp_expr_indent(Id),
3037		translate_op_params(Params),
3038		insertstr(' = '),
3039		indention_level(I1,I2),{I2 is I1+2,type_infos_in_subst(Params,Body,Body2)},
3040		translate_subst_begin_end(Body2),
3041		pp_description_pragma_of(Body2),
3042		indention_level(_,I1).
3043		translate_op_results([]) --> !.
3044		translate_op_results(Ids) --> pp_expr_indent_l(Ids), insertstr(' <-- ').
3045		translate_op_params([]) --> !.
3046		translate_op_params(Ids) --> insertstr('('),pp_expr_indent_l(Ids), insertstr(')').
3047
3048		translate_subst_begin_end(TSubst) -->
3049		{get_texpr_expr(TSubst,Subst),subst_needs_begin_end(Subst),
3050		create_texpr(block(TSubst),subst,[],Block)},!,
3051		translate_subst(Block).
3052		translate_subst_begin_end(Subst) -->
3053		translate_subst(Subst).
3054
3055		subst_needs_begin_end(assign(_,_)).
3056		subst_needs_begin_end(assign_single_id(_,_)).
3057		subst_needs_begin_end(parallel(_)).
3058		subst_needs_begin_end(sequence(_)).
3059		subst_needs_begin_end(operation_call(_,_,_)).
3060
3061		type_infos_in_subst([],Subst,Subst) :- !.
3062		type_infos_in_subst(Ids,SubstIn,SubstOut) :-
3063		get_preference(translate_print_typing_infos,true),!,
3064		type_infos_in_subst2(Ids,SubstIn,SubstOut).
3065		type_infos_in_subst(_Ids,Subst,Subst).
3066		type_infos_in_subst2(Ids,SubstIn,SubstOut) :-
3067		get_texpr_expr(SubstIn,precondition(P1,S)),!,
3068		get_texpr_info(SubstIn,Info),
3069		create_texpr(precondition(P2,S),pred,Info,SubstOut),
3070		add_typing_predicates(Ids,P1,P2).
3071		type_infos_in_subst2(Ids,SubstIn,SubstOut) :-
3072		create_texpr(precondition(P,SubstIn),pred,[],SubstOut),
3073		generate_typing_predicates(Ids,Typing),
3074		conjunct_predicates(Typing,P).
3075
3076
3077
3078
3079
3080		% pretty-print the internal section about included and used machines
3081		translate_used([]) --> !.
3082		translate_used([Used|Rest]) -->
3083		translate_used2(Used),
3084		translate_used(Rest).
3085		translate_used2(includeduse(Name,Id,NewTExpr)) -->
3086		indent,pp_expr_indent(NewTExpr),
3087		insertstr(' --> '), insertstr(Name), insertstr(':'), insertstr(Id).
3088
3089		% pretty-print the internal information about freetypes
3090		translate_freetypes([]) --> !.
3091		translate_freetypes([Freetype|Frest]) -->
3092		translate_freetype(Freetype),
3093		translate_freetypes(Frest).
3094		translate_freetype(freetype(Name,Cases)) -->
3095		{pretty_freetype(Name,PName)},
3096		indent(PName),insertstr('= '),
3097		indention_level(I1,I2),{I2 is I1+2},
3098		translate_freetype_cases(Cases),
3099		indention_level(_,I1).
3100		translate_freetype_cases([]) --> !.
3101		translate_freetype_cases([case(Name,Type)|Rest]) --> {nonvar(Type),Type=constant(_)},
3102		!,indent(Name),insert_comma(Rest),
3103		translate_freetype_cases(Rest).
3104		translate_freetype_cases([case(Name,Type)|Rest]) -->
3105		{pretty_type(Type,PT)},
3106		indent(Name),
3107		insertstr('('),insertstr(PT),insertstr(')'),
3108		insert_comma(Rest),
3109		translate_freetype_cases(Rest).
3110
3111		insert_comma([]) --> [].
3112		insert_comma([_|_]) --> insertstr(',').
3113
3114		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3115		% substitutions
3116
3117		translate_subst_or_bexpr(Stmt,String) :- get_texpr_type(Stmt,subst),!,
3118		translate_substitution(Stmt,String).
3119		translate_subst_or_bexpr(ExprOrPred,String) :-
3120		translate_bexpression(ExprOrPred,String).
3121
3122		translate_subst_or_bexpr_with_limit(Stmt,Limit,String) :-
3123		translate_subst_or_bexpr_with_limit(Stmt,Limit,report_errors,String).
3124		translate_subst_or_bexpr_with_limit(Stmt,_Limit,ReportErrors,String) :- get_texpr_type(Stmt,subst),!,
3125		translate_substitution(Stmt,String,ReportErrors). % TO DO: use limit
3126		translate_subst_or_bexpr_with_limit(ExprOrPred,Limit,ReportErrors,String) :-
3127		translate_bexpression_with_limit(ExprOrPred,Limit,ReportErrors,String).
3128
3129		print_subst(Stmt) :- translate_substitution(Stmt,T), print(T).
3130		translate_substitution(Stmt,String) :- translate_substitution(Stmt,String,report_errors).
3131		translate_substitution(Stmt,String,_) :-
3132		translate_subst_with_indention(Stmt,0,Codes,[]),
3133		(Codes = [10|C] -> true ; Codes=[13|C] -> true ; Codes=C), % peel off leading newline
3134		atom_codes_with_limit(String, C),!.
3135		translate_substitution(Stmt,String,report_errors) :-
3136		add_error(translate_substitution,'Could not translate substitution: ',Stmt),
3137		String='???'.
3138
3139		translate_subst_with_indention(TS,Indention,I,O) :-
3140		translate_subst(TS,(Indention,I),(_,O)).
3141		translate_subst_with_indention_and_label(TS,Indention,I,O) :-
3142		translate_subst_with_label(TS,(Indention,I),(_,O)).
3143
3144		translate_subst(TS) -->
3145		( {get_texpr_expr(TS,S)} ->
3146		translate_subst2(S)
3147		; translate_subst2(TS)).
3148
3149		translate_subst_with_label(TS) -->
3150		( {get_texpr_expr(TS,S)} ->
3151		indent_rodin_label(TS), % pretty print substitution labels
3152		translate_subst2(S)
3153		; translate_subst2(TS)).
3154
3155		% will print (first) rodin or pragma label indendent
3156		:- public indent_rodin_label/3.
3157		indent_rodin_label(_TExpr) --> {get_preference(translate_suppress_rodin_positions_flag,true),!}.
3158		indent_rodin_label(_TExpr) --> {get_preference(bugly_pp_scrambling,true),!}.
3159		indent_rodin_label(TExpr) --> {get_texpr_labels(TExpr,Names)},!, % note: this will only get the first label
3160		indent('/* @'),pp_ids_indent(Names),insertstr('*/ '). % this Camille syntax cannot be read back in by B parser
3161		indent_rodin_label(_TExpr) --> [].
3162
3163		pp_ids_indent([]) --> !, [].
3164		pp_ids_indent([ID]) --> !,pp_expr_indent(identifier(ID)).
3165		pp_ids_indent([ID|T]) --> !,pp_expr_indent(identifier(ID)), insertstr(' '),pp_ids_indent(T).
3166		pp_ids_indent(X) --> {add_error(pp_ids_indent,'Not a list of atoms: ',pp_ids_indent(X))}.
3167
3168		translate_subst2(Var) --> {var(Var)}, !, "_", {add_warning(translate_subst,'Variable subst:',Var)}.
3169		translate_subst2(skip) -->
3170		indent(skip).
3171		translate_subst2(operation(Id,Res,Params,Body)) --> translate_operation(Id,Res,Params,Body). % not really a substition that can appear normally
3172		translate_subst2(precondition(P,S)) -->
3173		indent('PRE '), pred_over_lines(2,'@grd',P), indent('THEN'), insert_subst(S), indent('END').
3174		translate_subst2(assertion(P,S)) -->
3175		indent('ASSERT '), pp_expr_indent(P), indent('THEN'), insert_subst(S), indent('END').
3176		translate_subst2(witness_then(P,S)) -->
3177		indent('WITNESS '), pp_expr_indent(P), indent('THEN'), insert_subst(S), indent('END').
3178		translate_subst2(block(S)) -->
3179		indent('BEGIN'), insert_subst(S), indent('END').
3180		translate_subst2(assign([L],[R])) --> !,
3181		indent,pp_expr_indent(L),insertstr(' := '),pp_expr_indent(R).
3182		translate_subst2(assign(L,R)) -->
3183	?	{(member(b(E,_,_),R), can_indent_expr(E)
3184		-> maplist(create_assign,L,R,ParAssigns))},!, % split into parallel assignments so that we can indent
3185		translate_subst2(parallel(ParAssigns)).
3186		translate_subst2(assign(L,R)) -->
3187		indent,pp_expr_indent_l(L),insertstr(' := '),pp_expr_indent_l(R).
3188		translate_subst2(assign_single_id(L,R)) -->
3189		translate_subst2(assign([L],[R])).
3190		translate_subst2(becomes_element_of(L,R)) -->
3191		indent,pp_expr_indent_l(L),insertstr(' :: '),pp_expr_indent(R).
3192		translate_subst2(becomes_such(L,R)) -->
3193		indent,pp_expr_indent_l(L),insertstr(' : '), insertstr('('),
3194		{ add_optional_typing_predicates(L,R,R1) },
3195		pp_expr_indent(R1), insertstr(')').
3196		translate_subst2(evb2_becomes_such(L,R)) --> translate_subst2(becomes_such(L,R)).
3197		translate_subst2(if([Elsif|Rest])) -->
3198		{ get_if_elsif(Elsif,P,S) },
3199		indent('IF '), pp_expr_indent(P), insertstr(' THEN'),
3200		insert_subst(S),
3201		translate_ifs(Rest).
3202		translate_subst2(if_elsif(P,S)) --> % not a legal top-level construct; but can be called in b_portray_hook
3203		indent('IF '), pp_expr_indent(P), insertstr(' THEN'),
3204		insert_subst(S),
3205		indent('END').
3206		translate_subst2(choice(Ss)) --> indent(' CHOICE'),
3207		split_over_lines(Ss,'OR'),
3208		indent('END'). % indentation seems too far
3209		translate_subst2(parallel(Ss)) -->
3210		split_over_lines(Ss,'||').
3211		translate_subst2(init_statement(S)) --> insert_subst(S).
3212		translate_subst2(sequence(Ss)) -->
3213		split_over_lines(Ss,';').
3214		translate_subst2(operation_call(Id,Rs,As)) -->
3215		indent,translate_op_results(Rs),
3216		pp_expr_indent(Id),
3217		translate_op_params(As).
3218		translate_subst2(identifier(op(Id))) --> % shouldn't normally appear
3219		indent,pp_expr_indent(identifier(Id)).
3220		translate_subst2(external_subst_call(Symbol,Args)) -->
3221		indent,
3222		pp_expr_indent(identifier(Symbol)),
3223		translate_op_params(Args).
3224		translate_subst2(any(Ids,Pred,Subst)) -->
3225		indent('ANY '), pp_expr_indent_l(Ids),
3226		indent('WHERE '),
3227		{add_optional_typing_predicates(Ids,Pred,Pred2)},
3228		pred_over_lines(2,'@grd',Pred2), indent('THEN'),
3229		insert_subst(Subst),
3230		indent('END').
3231		translate_subst2(select(Whens)) -->
3232		translate_whens(Whens,'SELECT '),
3233		indent('END').
3234		translate_subst2(select_when(Cond,Then)) --> % not a legal top-level construct; but can be called in b_portray_hook
3235		indent('WHEN'),
3236		pp_expr_indent(Cond),
3237		indent('THEN'),
3238		insert_subst(Then),
3239		indent('END').
3240		translate_subst2(select(Whens,Else)) -->
3241		translate_whens(Whens,'SELECT '),
3242		indent('ELSE'), insert_subst(Else),
3243		indent('END').
3244		translate_subst2(var(Ids,S)) -->
3245		indent('VAR '),
3246		pp_expr_indent_l(Ids),
3247		indent('IN'),insert_subst(S),
3248		indent('END').
3249		translate_subst2(let(Ids,P,S)) -->
3250		indent('LET '),
3251		pp_expr_indent_l(Ids),
3252		insertstr(' BE '), pp_expr_indent(P),
3253		indent('IN'), insert_subst(S),
3254		indent('END').
3255		translate_subst2(lazy_let_subst(TID,P,S)) -->
3256		indent('LET '),
3257		pp_expr_indent_l([TID]),
3258		insertstr(' BE '), pp_expr_indent(P), % could be expr or pred
3259		indent('IN'), insert_subst(S),
3260		indent('END').
3261		translate_subst2(case(Expression,Cases,ELSE)) -->
3262		% CASE E OF EITHER m THEN G OR n THEN H ... ELSE I END END
3263		indent('CASE '),
3264		pp_expr_indent(Expression), insertstr(' OF'),
3265		indent('EITHER '), translate_cases(Cases),
3266		indent('ELSE '), insert_subst(ELSE), % we could drop this if ELSE is skip ?
3267		indent('END END').
3268		translate_subst2(while(Pred,Subst,Inv,Var)) -->
3269		indent('WHILE '), pp_expr_indent(Pred),
3270		indent('DO'),insert_subst(Subst),
3271		indent('INVARIANT '),pp_expr_indent(Inv),
3272		indent('VARIANT '),pp_expr_indent(Var),
3273		indent('END').
3274		translate_subst2(while1(Pred,Subst,Inv,Var)) -->
3275		indent('WHILE /* 1 */ '), pp_expr_indent(Pred),
3276		indent('DO'),insert_subst(Subst),
3277		indent('INVARIANT '),pp_expr_indent(Inv),
3278		indent('VARIANT '),pp_expr_indent(Var),
3279		indent('END').
3280		translate_subst2(rlevent(Id,Section,Status,Parameters,Guard,Theorems,Actions,VWitnesses,PWitnesses,_Unmod,Refines)) -->
3281		indent,
3282		insert_status(Status),
3283		insertstr('EVENT '),
3284		({Id = 'INITIALISATION'}
3285		-> [] % avoid BLexer error in ProB2-UI, BLexerException: Invalid combination of symbols: 'INITIALISATION' and '='.
3286		; insertstr(Id), insertstr(' = ')),
3287		insertstr('/'), insertstr('* of machine '),
3288		insertstr(Section),insertstr(' */'),
3289		insert_variant(Status),
3290		( {Parameters=[], get_texpr_expr(Guard,truth)} ->
3291		{NoGuard=true} % indent('BEGIN ')
3292		; {Parameters=[]} ->
3293		indent('WHEN '),
3294		pred_over_lines(2,'@grd',Guard)
3295		;
3296		indent('ANY '),pp_expr_indent_l(Parameters),
3297		indent('WHERE '),
3298		pred_over_lines(2,'@grd',Guard)
3299		),
3300		( {VWitnesses=[],PWitnesses=[]} ->
3301		[]
3302		;
3303		{append(VWitnesses,PWitnesses,Witnesses)},
3304		indent('WITH '),pp_witness_l(Witnesses)
3305		),
3306		{( Actions=[] ->
3307		create_texpr(skip,subst,[],Subst)
3308		;
3309		create_texpr(parallel(Actions),subst,[],Subst)
3310		)},
3311		( {Theorems=[]} -> {true}
3312		;
3313		indent('THEOREMS '),
3314		preds_over_lines(2,'@thm',Theorems)
3315		),
3316		({NoGuard==true}
3317		-> indent('BEGIN ') % avoid BLexer errors in ProB2-UI Syntax highlighting
3318		; indent('THEN ')
3319		),
3320		insert_subst(Subst),
3321		pp_refines_l(Refines,Id),
3322		indent('END').
3323
3324		% translate cases of a CASE statement
3325		translate_cases([]) --> !,[].
3326		translate_cases([CaseOr|T]) -->
3327		{get_texpr_expr(CaseOr,case_or(Exprs,Subst))},!,
3328		pp_expr_indent_l(Exprs),
3329		insertstr(' THEN '),
3330		insert_subst(Subst),
3331		({T==[]} -> {true}
3332		; indent('OR '), translate_cases(T)).
3333		translate_cases(L) -->
3334		{add_internal_error('Cannot translate CASE list: ',translate_cases(L,_,_))}.
3335
3336		insert_status(TStatus) -->
3337		{get_texpr_expr(TStatus,Status),
3338		status_string(Status,String)},
3339		insertstr(String).
3340		status_string(ordinary,'').
3341		status_string(anticipated(_),'ANTICIPATED ').
3342		status_string(convergent(_),'CONVERGENT ').
3343
3344		insert_variant(TStatus) -->
3345		{get_texpr_expr(TStatus,Status)},
3346		insert_variant2(Status).
3347		insert_variant2(ordinary) --> !.
3348		insert_variant2(anticipated(Variant)) --> insert_variant3(Variant).
3349		insert_variant2(convergent(Variant)) --> insert_variant3(Variant).
3350		insert_variant3(Variant) -->
3351		indent('USING VARIANT '),pp_expr_indent(Variant).
3352
3353		pp_refines_l([],_) --> [].
3354		pp_refines_l([Ref|Rest],Id) -->
3355		pp_refines(Ref,Id),pp_refines_l(Rest,Id).
3356		pp_refines(Refined,_Id) -->
3357		% indent(Id), insertstr(' REFINES '),
3358		indent('REFINES '),
3359		insert_subst(Refined).
3360
3361		pp_witness_l([]) --> [].
3362		pp_witness_l([Witness|WRest]) -->
3363		pp_witness(Witness),pp_witness_l(WRest).
3364		pp_witness(Expr) -->
3365		indention_level(I1,I2),
3366		{get_texpr_expr(Expr,witness(Id,Pred)),
3367		I2 is I1+2},
3368		indent, pp_expr_indent(Id), insertstr(': '),
3369		pp_expr_indent(Pred),
3370		pp_description_pragma_of(Pred),
3371		indention_level(_,I1).
3372
3373
3374		translate_whens([],_) --> !.
3375		translate_whens([When|Rest],T) -->
3376		{get_texpr_expr(When,select_when(P,S))},!,
3377		indent(T), pred_over_lines(2,'@grd',P),
3378		indent('THEN '),
3379		insert_subst(S),
3380		translate_whens(Rest,'WHEN ').
3381		translate_whens(L,_) -->
3382		{add_internal_error('Cannot translate WHEN: ',translate_whens(L,_,_,_))}.
3383
3384
3385
3386		create_assign(LHS,RHS,b(assign([LHS],[RHS]),subst,[])).
3387
3388		split_over_lines([],_) --> !.
3389		split_over_lines([S|Rest],Symbol) --> !,
3390		indention_level(I1,I2),{atom_codes(Symbol,X),length(X,N),I2 is I1+N+1},
3391		translate_subst_check(S),
3392		split_over_lines2(Rest,Symbol,I1,I2).
3393		split_over_lines(S,Symbol) --> {add_error(split_over_lines,'Illegal argument: ',Symbol:S)}.
3394
3395		split_over_lines2([],_,_,_) --> !.
3396		split_over_lines2([S|Rest],Symbol,I1,I2) -->
3397		indention_level(_,I1), indent(Symbol),
3398		indention_level(_,I2), translate_subst(S),
3399		split_over_lines2(Rest,Symbol,I1,I2).
3400
3401		% print a predicate over several lines, at most one conjunct per line
3402		% N is the increment that should be added to the indentation
3403		%pred_over_lines(N,Pred) --> pred_over_lines(N,'@pred',Pred).
3404		pred_over_lines(N,Lbl,Pred) -->
3405		{conjunction_to_list(Pred,List)},
3406		preds_over_lines(N,Lbl,List).
3407		section_pred_over_lines(N,Title,Pred) -->
3408		({get_eventb_default_label(Title,Lbl)} -> [] ; {Lbl='@pred'}),
3409		pred_over_lines(N,Lbl,Pred).
3410		get_eventb_default_label(properties,'@axm').
3411		get_eventb_default_label(assertions,'@thm').
3412
3413		% print a list of predicates over several lines, at most one conjunct per line
3414		preds_over_lines(N,Lbl,Preds) --> preds_over_lines(N,Lbl,'& ',Preds).
3415		% preds_over_lines(IndentationIncrease,EventBDefaultLabel,ClassicalBSeperator,ListOfPredicates)
3416		preds_over_lines(N,Lbl,Sep,Preds) -->
3417		indention_level(I1,I2),{I2 is I1+N},
3418		preds_over_lines1(Preds,Lbl,1,Sep),
3419		indention_level(_,I1).
3420		preds_over_lines1([],Lbl,Nr,Sep) --> !,
3421		preds_over_lines1([b(truth,pred,[])],Lbl,Nr,Sep).
3422		preds_over_lines1([H|T],Lbl,Nr,Sep) -->
3423		indent(' '), pp_label(Lbl,Nr),
3424		%({T==[]} -> pp_expr_indent(H) ; pp_expr_m_indent(H,40)),
3425		({T==[]} -> pp_pred_nested(H,conjunct,0) ; pp_pred_nested(H,conjunct,40)),
3426		pp_description_pragma_of(H),
3427		{N1 is Nr+1},
3428		preds_over_lines2(T,Lbl,N1,Sep).
3429		preds_over_lines2([],_,_,_Sep) --> !.
3430		preds_over_lines2([E|Rest],Lbl,Nr,Sep) -->
3431		({force_eventb_rodin_mode} -> indent(' '), pp_label(Lbl,Nr) ; indent(Sep)),
3432		pp_pred_nested(E,conjunct,40),
3433		pp_description_pragma_of(E),
3434		{N1 is Nr+1},
3435		preds_over_lines2(Rest,Lbl,N1,Sep).
3436
3437		% print event-b label for Rodin/Camille:
3438		pp_label(Lbl,Nr) -->
3439		({force_eventb_rodin_mode}
3440		-> {atom_codes(Lbl,C1), number_codes(Nr,NC), append(C1,NC,AC), atom_codes(A,AC)},
3441		pp_atom_indent(A), pp_atom_indent(' ')
3442		; []).
3443
3444		% a version of nested_print_bexpr / nbp that does not directly print to stream conjunct
3445		pp_pred_nested(TExpr,CurrentType,_) --> {TExpr = b(E,pred,_)},
3446		{get_binary_connective(E,NewType,Ascii,LHS,RHS), binary_infix(NewType,Ascii,Prio,left)},
3447		!,
3448		pp_rodin_label_indent(TExpr), % print any label
3449		inc_lvl(CurrentType,NewType),
3450		pp_pred_nested(LHS,NewType,Prio),
3451		{translate_in_mode(NewType,Ascii,Symbol)},
3452		indent(' '),pp_atom_indent(Symbol),
3453		indent(' '),
3454		{(is_associative(NewType) -> NewTypeR=NewType % no need for parentheses if same operator on right
3455		; NewTypeR=right(NewType))},
3456		pp_pred_nested(RHS,NewTypeR,Prio),
3457		dec_lvl(CurrentType,NewType).
3458		pp_pred_nested(TExpr,_,_) --> {is_nontrivial_negation(TExpr,NExpr,InnerType,Prio)},
3459		!,
3460		pp_rodin_label_indent(TExpr), % print any label
3461		{translate_in_mode(negation,'not',Symbol)},
3462		pp_atom_indent(Symbol),
3463		inc_lvl(other,negation), % always need parentheses for negation
3464		pp_pred_nested(NExpr,InnerType,Prio),
3465		dec_lvl(other,negation).
3466		pp_pred_nested(TExpr,_,_) --> {TExpr = b(exists(Ids,RHS),pred,_)},
3467		!,
3468		pp_rodin_label_indent(TExpr), % print any label
3469		{translate_in_mode(exists,'#',FSymbol)},
3470		%indent(' '),
3471		pp_atom_indent(FSymbol),
3472		pp_expr_ids_in_mode_indent(Ids),pp_atom_indent('.'),
3473		inc_lvl(other,conjunct), % always need parentheses here
3474		{add_normal_typing_predicates(Ids,RHS,RHST), Prio=40}, % Prio of conjunction
3475		pp_pred_nested(RHST,conjunct,Prio),
3476		dec_lvl(other,conjunct).
3477		pp_pred_nested(TExpr,_,_) --> {TExpr = b(forall(Ids,LHS,RHS),pred,_)},
3478		!,
3479		pp_rodin_label_indent(TExpr), % print any label
3480		{translate_in_mode(forall,'!',FSymbol)},
3481		%indent(' '),
3482		pp_atom_indent(FSymbol),
3483		pp_expr_ids_in_mode_indent(Ids),pp_atom_indent('.'),
3484		inc_lvl(other,implication), % always need parentheses here
3485		{add_normal_typing_predicates(Ids,LHS,LHST), Prio=30}, % Prio of implication
3486		pp_pred_nested(LHST,implication,Prio),
3487		{translate_in_mode(implication,'=>',Symbol)},
3488		indent(' '),pp_atom_indent(Symbol),
3489		indent(' '),
3490		pp_pred_nested(RHS,right(implication),Prio),
3491		dec_lvl(other,implication).
3492		pp_pred_nested(TExpr,_,_) -->
3493		{\+ eventb_translation_mode,
3494		TExpr = b(let_predicate(Ids,Exprs,Body),pred,_)
3495		}, %Ids=[_]}, % TODO: enable printing with more than one id; see below
3496		!,
3497		pp_let_nested(Ids,Exprs,Body).
3498		pp_pred_nested(b(BOP,pred,_),_CurrentType,CurMinPrio) -->
3499		{indent_binary_predicate(BOP,LHS,RHS,OpStr),
3500		get_texpr_id(LHS,_),can_indent_texpr(RHS)},!,
3501		pp_expr_m_indent(LHS,CurMinPrio),
3502		insertstr(OpStr),
3503		increase_indentation_level(2),
3504		indent(''),
3505		pp_expr_indent(RHS), % only supports %, {}, bool which do not need parentheses
3506		decrease_indentation_level(2).
3507		pp_pred_nested(Expr,_CurrentType,CurMinPrio) --> {can_indent_texpr(Expr)},!,
3508		pp_expr_m_indent(Expr,CurMinPrio).
3509		pp_pred_nested(Expr,_CurrentType,CurMinPrio) --> pp_expr_m_indent(Expr,CurMinPrio).
3510
3511		indent_binary_predicate(equal(LHS,RHS),LHS,RHS,' = ').
3512		indent_binary_predicate(member(LHS,RHS),LHS,RHS,' : ').
3513
3514		pp_let_nested(Ids,Exprs,Body) -->
3515		indent('LET '),
3516		pp_expr_indent_l(Ids),
3517		insertstr(' BE '),
3518		{maplist(create_equality,Ids,Exprs,Equalities)},
3519		preds_over_lines(2,'@let_eq',Equalities),
3520		indent(' IN '),
3521		increase_indentation_level(2),
3522		pp_pred_nested(Body,let_predicate,40),
3523		decrease_indentation_level(2),
3524		indent(' END').
3525		pp_let_expr_nested(Ids,Exprs,Body) -->
3526		insertstr('LET '),
3527		pp_expr_indent_l(Ids),
3528		insertstr(' BE '),
3529		{maplist(create_equality,Ids,Exprs,Equalities)},
3530		preds_over_lines(2,'@let_eq',Equalities),
3531		indent('IN '),
3532		increase_indentation_level(2),
3533		pp_expr_indent(Body),
3534		decrease_indentation_level(2),
3535		indent('END').
3536
3537		is_nontrivial_negation(b(negation(NExpr),pred,_),NExpr,NewType,Prio) :-
3538		get_texpr_expr(NExpr,E),
3539		(E=negation(_) -> NewType=other,Prio=0
3540		; get_binary_connective(E,NewType,Ascii,_,_),
3541		binary_infix(NewType,Ascii,Prio,_Assoc)).
3542
3543		pp_rodin_label_indent(b(_,_,Infos),(I,S),(I,T)) :- pp_rodin_label(Infos,S,T).
3544		% note: below we will print unnecessary parentheses in case of Atelier-B mode; but for readability it maye be better to add them
3545		inc_lvl(Old,New) --> {New=Old}, !,[].
3546		inc_lvl(_,_) --> pp_atom_indent('('), % not strictly necessary if higher_prio
3547		increase_indentation_level, indent(' ').
3548		dec_lvl(Old,New) --> {New=Old}, !,[].
3549		dec_lvl(_,_) --> decrease_indentation_level, indent(' '),pp_atom_indent(')').
3550
3551		is_associative(conjunct).
3552		is_associative(disjunct).
3553
3554		%higher_prio(conjunct,implication).
3555		%higher_prio(disjunct,implication).
3556		% priority of equivalence changes in Rodin vs Atelier-B, maybe better add parentheses
3557
3558		translate_ifs([]) --> !,
3559		indent('END').
3560		translate_ifs([Elsif]) -->
3561		{get_if_elsif(Elsif,P,S),
3562		optional_type(P,truth)},!,
3563		indent('ELSE'), insert_subst(S), indent('END').
3564		translate_ifs([Elsif|Rest]) -->
3565		{get_if_elsif(Elsif,P,S)},!,
3566		indent('ELSIF '), pp_expr_indent(P), insertstr(' THEN'),
3567		insert_subst(S),
3568		translate_ifs(Rest).
3569		translate_ifs(ElseList) -->
3570		{functor(ElseList,F,A),add_error(translate_ifs,'Could not translate IF-THEN-ELSE: ',F/A-ElseList),fail}.
3571
3572		get_if_elsif(Elsif,P,S) :-
3573		(optional_type(Elsif,if_elsif(P,S)) -> true
3574		; add_internal_error('Is not an if_elsif:',get_if_elsif(Elsif,P,S)), fail).
3575
3576		insert_subst(S) -->
3577		indention_level(I,I2),{I2 is I+2},
3578		translate_subst_check(S),
3579		indention_level(_,I).
3580
3581		translate_subst_check(S) --> translate_subst(S),!.
3582		translate_subst_check(S) -->
3583		{b_functor(S,F,A),add_error(translate_subst,'Could not translate substitution: ',F/A-S),fail}.
3584
3585		b_functor(b(E,_,_),F,A) :- !,functor(E,F,A).
3586		b_functor(E,F,A) :- functor(E,F,A).
3587
3588		pp_description_pragma_of(enumerated_set_def(_,_)) --> !, "".
3589		pp_description_pragma_of(Expr) -->
3590		({get_texpr_description(Expr,Desc)}
3591		-> insert_atom(' /*@desc '), insert_atom(Desc), insert_atom(' */')
3592		; {true}).
3593		indent_expr(Expr) -->
3594		indent, pp_expr_indent(Expr),
3595		pp_description_pragma_of(Expr).
3596		%indent_expr_l([]) --> !.
3597		%indent_expr_l([Expr|Rest]) -->
3598		% indent_expr(Expr), indent_expr_l(Rest).
3599		indent_expr_l_sep([],_) --> !.
3600		indent_expr_l_sep([Expr|Rest],Sep) -->
3601		indent_expr(Expr),
3602		{(Rest=[] -> RealSep='' ; RealSep=Sep)},
3603		insert_atom(RealSep), % the threaded argument is a pair, not directly a string !
3604		indent_expr_l_sep(Rest,Sep).
3605		%indention_level(L) --> indention_level(L,L).
3606		increase_indentation_level --> indention_level(L,New), {New is L+1}.
3607		increase_indentation_level(N) --> indention_level(L,New), {New is L+N}.
3608		decrease_indentation_level --> indention_level(L,New), {New is L-1}.
3609		decrease_indentation_level(N) --> indention_level(L,New), {New is L-N}.
3610		indention_level(Old,New,(Old,S),(New,S)).
3611		indention_codes(Old,New,(Indent,Old),(Indent,New)).
3612		indent --> indent('').
3613		indent(M,(I,S),(I,T)) :- indent2(I,M,S,T).
3614		indent2(Level,Msg) -->
3615		"\n",do_indention(Level),ppatom(Msg).
3616
3617		insert_atom(Sep,(I,S),(I,T)) :- ppatom(Sep,S,T).
3618
3619		insertstr(M,(I,S),(I,T)) :- ppterm(M,S,T).
3620		insertcodes(M,(I,S),(I,T)) :- ppcodes(M,S,T).
3621
3622		do_indention(0,T,R) :- !, R=T.
3623		do_indention(N,[32|I],O) :-
3624		N>0,N2 is N-1, do_indention(N2,I,O).
3625
3626		optional_type(Typed,Expr) :- get_texpr_expr(Typed,E),!,Expr=E.
3627		optional_type(Expr,Expr).
3628
3629		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3630		% expressions and predicates
3631
3632		% pretty-type an expression in an indent-environment
3633		% currently, the indent level is just thrown away
3634		% TODO: pp_expr_indent dom( comprehension_set ) / union ( ...)
3635		pp_expr_indent(b(comprehension_set(Ids,Body),_,_)) -->
3636		{\+ eventb_translation_mode, % TODO: also print in Event-B mode:
3637		detect_lambda_comprehension(Ids,Body, FrontIDs,LambdaBody,ToExpr)},
3638		{add_normal_typing_predicates(FrontIDs,LambdaBody,TLambdaBody)},
3639		!,
3640		insertstr('%('), % to do: use lambda_symbol and improve layout below
3641		pp_expr_indent_l(FrontIDs),
3642		insertstr(') . ('),
3643		pred_over_lines(2,'@body',TLambdaBody),
3644		indent(' | '), increase_indentation_level(2),
3645		indent(''), pp_expr_indent(ToExpr), decrease_indentation_level(2),
3646		indent(')').
3647		pp_expr_indent(b(comprehension_set(Ids,Body),_,Info),(I,S),(I,T)) :-
3648		pp_comprehension_set5(Ids,Body,Info,_,special(_Kind),S,T),
3649		% throw away indent and check if a special pp rule is applicable
3650		!.
3651		pp_expr_indent(b(comprehension_set(Ids,Body),_,_)) -->
3652		!,
3653		insertstr('{'), pp_expr_indent_l(Ids),
3654		insertstr(' | '),
3655		pred_over_lines(2,'@body',Body),
3656		indent('}').
3657		pp_expr_indent(b(convert_bool(Body),_,_)) -->
3658		!,
3659		insertstr('bool('),
3660		pred_over_lines(2,'@bool',Body),
3661		indent(')').
3662		pp_expr_indent(b(if_then_else(Test,Then,Else),_,_)) -->
3663		!,
3664		insertstr('IF'),
3665		pred_over_lines(2,'@test',Test),
3666		indent('THEN'),increase_indentation_level(2),
3667		indent(''),pp_expr_indent(Then),decrease_indentation_level(2),
3668		indent('ELSE'),increase_indentation_level(2),
3669		indent(''),pp_expr_indent(Else),decrease_indentation_level(2),
3670		indent('END').
3671		pp_expr_indent(b(let_expression(Ids,Exprs,Body),_,_)) -->
3672		!,
3673		pp_let_expr_nested(Ids,Exprs,Body).
3674		% TODO: support a few more like dom/ran(comprehension_set) SIGMA, PI, \/ (union), ...
3675		pp_expr_indent(Expr,(I,S),(I,T)) :-
3676		%get_texpr_expr(Expr,F), functor(F,FF,NN), format(user_output,'Cannot indent: ~w/~w~n',[FF,NN]),
3677		pp_expr(Expr,_,_LimitReached,S,T). % throw away indent
3678
3679		can_indent_texpr(b(E,_,_)) :- can_indent_expr(E).
3680		can_indent_expr(comprehension_set(_,_)).
3681		can_indent_expr(convert_bool(_)).
3682		can_indent_expr(if_then_else(_,_,_)).
3683		can_indent_expr(let_expression(_,_,_)).
3684
3685		pp_expr_indent_l([E]) --> !, pp_expr_indent(E).
3686		pp_expr_indent_l(Exprs,(I,S),(I,T)) :-
3687		pp_expr_l(Exprs,_LR,S,T). % throw away indent
3688		pp_expr_m_indent(Expr,MinPrio,(I,S),(I,T)) :-
3689		pp_expr_m(Expr,MinPrio,_LimitReached,S,T).
3690		pp_atom_indent(A,(I,S),(I,T)) :- ppatom(A,S,T).
3691		pp_expr_ids_in_mode_indent(Ids,(I,S),(I,T)) :- pp_expr_ids_in_mode(Ids,_,S,T).
3692
3693
3694
3695
3696		is_boolean_value(b(B,boolean,_),BV) :- boolean_aux(B,BV).
3697		boolean_aux(boolean_true,pred_true).
3698		boolean_aux(boolean_false,pred_false).
3699		boolean_aux(value(V),BV) :- nonvar(V),!,BV=V.
3700
3701
3702		constants_in_mode(F,S) :-
3703		constants(F,S1), translate_in_mode(F,S1,S).
3704
3705		constants(pred_true,'TRUE').
3706		constants(pred_false,'FALSE').
3707		constants(boolean_true,'TRUE').
3708		constants(boolean_false,'FALSE').
3709		constants(max_int,'MAXINT').
3710		constants(min_int,'MININT').
3711		constants(empty_set,'{}').
3712		constants(bool_set,'BOOL').
3713		constants(float_set,'FLOAT').
3714		constants(real_set,'REAL').
3715		constants(string_set,'STRING').
3716		constants(empty_sequence,'[]').
3717		constants(event_b_identity,'id').
3718
3719		constants(truth,Res) :- eventb_translation_mode,!,Res=true.
3720		constants(truth,Res) :- animation_minor_mode(tla),!,Res='TRUE'.
3721		constants(truth,Res) :- atelierb_mode(_),!,Res='(TRUE:BOOL)'. % __truth; we could also do TRUE=TRUE
3722		constants(truth,'btrue').
3723		constants(falsity,Res) :- eventb_translation_mode,!,Res=false.
3724		constants(falsity,Res) :- animation_minor_mode(tla),!,Res='FALSE'.
3725		constants(falsity,Res) :- atelierb_mode(_),!,Res='(TRUE=FALSE)'.
3726		constants(falsity,'bfalse'). % __falsity
3727		constants(unknown_truth_value(Msg),Res) :- % special internal constant
3728		ajoin(['?(',Msg,')'],Res).
3729
3730		function_like_in_mode(F,S) :-
3731		function_like(F,S1),
3732		translate_in_mode(F,S1,S).
3733
3734		function_like(convert_bool,bool).
3735		function_like(convert_real,real). % cannot be used on its own: dom(real) is not accepted by Atelier-B
3736		function_like(convert_int_floor,floor). % ditto
3737		function_like(convert_int_ceiling,ceiling). % ditto
3738		function_like(successor,succ). % can also be used on its own; e.g., dom(succ)=INTEGER is ok
3739		function_like(predecessor,pred). % ditto
3740		function_like(max,max).
3741		function_like(max_real,max).
3742		function_like(min,min).
3743		function_like(min_real,min).
3744		function_like(card,card).
3745		function_like(pow_subset,'POW').
3746		function_like(pow1_subset,'POW1').
3747		function_like(fin_subset,'FIN').
3748		function_like(fin1_subset,'FIN1').
3749		function_like(identity,id).
3750		function_like(first_projection,prj1).
3751		function_like(first_of_pair,'prj1'). % used to be __first_of_pair, will be dealt with separately to generate parsable representation
3752		function_like(second_projection,prj2).
3753		function_like(second_of_pair,'prj2'). % used to be __second_of_pair, will be dealt with separately to generate parsable representation
3754		function_like(iteration,iterate).
3755		function_like(event_b_first_projection_v2,prj1).
3756		function_like(event_b_second_projection_v2,prj2).
3757		function_like(reflexive_closure,closure).
3758		function_like(closure,closure1).
3759		function_like(domain,dom).
3760		function_like(range,ran).
3761		function_like(seq,seq).
3762		function_like(seq1,seq1).
3763		function_like(iseq,iseq).
3764		function_like(iseq1,iseq1).
3765		function_like(perm,perm).
3766		function_like(size,size).
3767		function_like(first,first).
3768		function_like(last,last).
3769		function_like(front,front).
3770		function_like(tail,tail).
3771		function_like(rev,rev).
3772		function_like(general_concat,conc).
3773		function_like(general_union,union).
3774		function_like(general_intersection,inter).
3775		function_like(trans_function,fnc).
3776		function_like(trans_relation,rel).
3777		function_like(tree,tree).
3778		function_like(btree,btree).
3779		function_like(const,const).
3780		function_like(top,top).
3781		function_like(sons,sons).
3782		function_like(prefix,prefix).
3783		function_like(postfix,postfix).
3784		function_like(sizet,sizet).
3785		function_like(mirror,mirror).
3786		function_like(rank,rank).
3787		function_like(father,father).
3788		function_like(son,son).
3789		function_like(subtree,subtree).
3790		function_like(arity,arity).
3791		function_like(bin,bin).
3792		function_like(left,left).
3793		function_like(right,right).
3794		function_like(infix,infix).
3795
3796		function_like(rec,rec).
3797		function_like(struct,struct).
3798
3799		function_like(negation,not).
3800		function_like(bag_items,items).
3801
3802		function_like(finite,finite). % from Event-B, TO DO: if \+ eventb_translation_mode then print as S:FIN(S)
3803		function_like(witness,'@witness'). % from Event-B
3804
3805		function_like(floored_div,'FDIV') :- \+ animation_minor_mode(tla). % using external function
3806
3807		unary_prefix(unary_minus,-,210).
3808		unary_prefix(unary_minus_real,-,210).
3809		unary_prefix(mu,'MU',210) :- animation_minor_mode(z).
3810
3811		unary_prefix_parentheses(compaction,'compaction').
3812		unary_prefix_parentheses(bag_items,'bag_items').
3813		unary_prefix_parentheses(mu,'MU') :- \+ animation_minor_mode(z). % write with () for external function
3814
3815		unary_postfix(reverse,'~',230). % relational inverse
3816
3817
3818		always_surround_by_parentheses(parallel_product).
3819		always_surround_by_parentheses(composition).
3820
3821		binary_infix_symbol(b(T,_,_),Symbol) :- functor(T,F,2), binary_infix_in_mode(F,Symbol,_,_).
3822
3823		% EXPR * EXPR --> EXPR
3824		binary_infix(composition,';',20,left).
3825		binary_infix(overwrite,'<+',160,left).
3826		binary_infix(direct_product,'><',160,left). % Rodin requires parentheses
3827		binary_infix(parallel_product,'||',20,left).
3828		binary_infix(concat,'^',160,left).
3829		binary_infix(relations,'<->',125,left).
3830		binary_infix(partial_function,'+->',125,left).
3831		binary_infix(total_function,'-->',125,left).
3832		binary_infix(partial_injection,'>+>',125,left).
3833		binary_infix(total_injection,'>->',125,left).
3834		binary_infix(partial_surjection,'+->>',125,left).
3835		binary_infix(total_surjection,Symbol,125,left) :-
3836		(eventb_translation_mode -> Symbol = '->>'; Symbol = '-->>').
3837		binary_infix(total_bijection,'>->>',125,left).
3838		binary_infix(partial_bijection,'>+>>',125,left).
3839		binary_infix(total_relation,'<<->',125,left). % only in Event-B
3840		binary_infix(surjection_relation,'<->>',125,left). % only in Event-B
3841		binary_infix(total_surjection_relation,'<<->>',125,left). % only in Event-B
3842		binary_infix(insert_front,'->',160,left).
3843		binary_infix(insert_tail,'<-',160,left).
3844		binary_infix(domain_restriction,'<|',160,left).
3845		binary_infix(domain_subtraction,'<<|',160,left).
3846		binary_infix(range_restriction,'|>',160,left).
3847		binary_infix(range_subtraction,'|>>',160,left).
3848		binary_infix(intersection,'/\\',160,left).
3849		binary_infix(union,'\\/',160,left).
3850		binary_infix(restrict_front,'/|\\',160,left).
3851		binary_infix(restrict_tail,'\\|/',160,left).
3852		binary_infix(couple,'|->',160,left).
3853		binary_infix(interval,'..',170,left).
3854		binary_infix(add,+,180,left).
3855		binary_infix(add_real,+,180,left).
3856		binary_infix(minus,-,180,left).
3857		binary_infix(minus_real,-,180,left).
3858		binary_infix(set_subtraction,'\\',180,left) :- eventb_translation_mode,!. % symbol is not allowed by Atelier-B
3859		binary_infix(set_subtraction,-,180,left).
3860		binary_infix(minus_or_set_subtract,-,180,left).
3861		binary_infix(multiplication,*,190,left).
3862		binary_infix(multiplication_real,*,190,left).
3863		binary_infix(cartesian_product,**,190,left) :- eventb_translation_mode,!.
3864		binary_infix(cartesian_product,*,190,left).
3865		binary_infix(mult_or_cart,*,190,left). % in case type checker not yet run
3866		binary_infix(div,/,190,left).
3867		binary_infix(div_real,/,190,left).
3868		binary_infix(floored_div,div,190,left) :- animation_minor_mode(tla).
3869		binary_infix(modulo,mod,190,left).
3870		binary_infix(power_of,**,200,right).
3871		binary_infix(power_of_real,**,200,right).
3872		binary_infix(typeof,oftype,120,right). % Event-B oftype operator; usually removed by btypechecker, technically has no associativity in our parser, but right associativity matches better
3873
3874		binary_infix(ring,'\x2218\',160,left). % our B Parser gives ring same priority as direct_product or overwrite
3875
3876		% PRED * PRED --> PRED
3877		binary_infix(implication,'=>',30,left).
3878		binary_infix(conjunct,'&',40,left).
3879		binary_infix(disjunct,or,40,left).
3880		binary_infix(equivalence,'<=>',Prio,left) :- % in Rodin this has the same priority as implication
3881		(eventb_translation_mode -> Prio=30 ; Prio=60).
3882
3883
3884		% EXPR * EXPR --> PRED
3885		binary_infix(equal,=,60,left).
3886		binary_infix(not_equal,'/=',160,left).
3887		binary_infix(less_equal,'<=',160,left).
3888		binary_infix(less,'<',160,left).
3889		binary_infix(less_equal_real,'<=',160,left).
3890		binary_infix(less_real,'<',160,left).
3891		binary_infix(greater_equal,'>=',160,left).
3892		binary_infix(greater,'>',160,left).
3893		binary_infix(member,':',60,left).
3894		binary_infix(not_member,'/:',160,left).
3895		binary_infix(subset,'<:',110,left).
3896		binary_infix(subset_strict,'<<:',110,left).
3897		binary_infix(not_subset,'/<:',110,left).
3898		binary_infix(not_subset_strict,'/<<:',110,left).
3899
3900		binary_infix(values_entry,'=',60,left).
3901
3902		% atelierb_mode(prover(_)): translation for AtelierB's PP/ML prover
3903		% atelierb_mode(native): translation to native B supported by AtelierB
3904		:- dynamic latex_mode/0, unicode_mode/0, atelierb_mode/1, force_eventb_rodin_mode/0.
3905
3906		%latex_mode.
3907		%unicode_mode.
3908		%force_eventb_rodin_mode. % Force Event-B output even if not in eventb minor mode
3909
3910		eventb_translation_mode :- animation_minor_mode(eventb),!.
3911		eventb_translation_mode :- force_eventb_rodin_mode.
3912
3913		set_force_eventb_mode :- assertz(force_eventb_rodin_mode).
3914		unset_force_eventb_mode :-
3915		(retract(force_eventb_rodin_mode) -> true ; add_internal_error('Was not in forced Event-B mode: ',force_eventb_rodin_mode)).
3916
3917		set_unicode_mode :- assertz(unicode_mode).
3918		set_latex_mode :- assertz(latex_mode).
3919		unset_unicode_mode :-
3920		(retract(unicode_mode) -> true ; add_internal_error('Was not in Unicode mode: ',unset_unicode_mode)).
3921		unset_latex_mode :-
3922		(retract(latex_mode) -> true
3923		; add_internal_error('Was not in Latex mode: ',unset_latex_mode)).
3924
3925		set_atelierb_mode(Mode) :- asserta(atelierb_mode(Mode)).
3926		unset_atelierb_mode :-
3927		(retract(atelierb_mode(_)) -> true ; add_internal_error('Was not in Atelier-B mode: ',unset_atelierb_mode)).
3928
3929		get_translation_mode(M) :- unicode_mode, !, M=unicode.
3930		get_translation_mode(M) :- latex_mode, !, M=latex.
3931		get_translation_mode(M) :- atelierb_mode(native), !, M=atelierb.
3932		get_translation_mode(M) :- atelierb_mode(prover(pp)), !, M=atelierb_pp.
3933		get_translation_mode(M) :- atelierb_mode(prover(ml)), !, M=atelierb_ml.
3934		get_translation_mode(ascii).
3935
3936		% TO DO: provide better stack-based setting/unsetting of modes or use options parameter
3937		set_translation_mode(ascii) :- !, retractall(unicode_mode), retractall(latex_mode), retractall(atelierb_mode(_)).
3938		set_translation_mode(unicode) :- !, set_unicode_mode.
3939		set_translation_mode(latex) :- !, set_latex_mode.
3940		set_translation_mode(atelierb) :- !, set_atelierb_mode(native).
3941		set_translation_mode(atelierb_pp) :- !, set_atelierb_mode(prover(pp)). % translation for PP/ML prover
3942		set_translation_mode(atelierb_ml) :- !, set_atelierb_mode(prover(ml)).
3943		set_translation_mode(Mode) :- add_internal_error('Illegal mode:',set_translation_mode(Mode)).
3944
3945		unset_translation_mode(ascii) :- !.
3946		unset_translation_mode(unicode) :- !,unset_unicode_mode.
3947		unset_translation_mode(latex) :- !,unset_latex_mode.
3948		unset_translation_mode(atelierb) :- !,unset_atelierb_mode.
3949		unset_translation_mode(atelierb_pp) :- !,unset_atelierb_mode.
3950		unset_translation_mode(atelierb_ml) :- !,unset_atelierb_mode.
3951		unset_translation_mode(Mode) :- add_internal_error('Illegal mode:',unset_translation_mode(Mode)).
3952
3953		with_translation_mode(Mode, Call) :-
3954		get_translation_mode(OldMode),
3955		(OldMode == Mode -> Call ;
3956		set_translation_mode(ascii), % Clear all existing translation mode settings first
3957		set_translation_mode(Mode),
3958		call_cleanup(Call, set_translation_mode(OldMode))
3959		% FIXME This might not restore all translation modes fully!
3960		% For example, if both unicode_mode and latex_mode are set,
3961		% then with_translation_mode(ascii, ...) will only restore unicode_mode.
3962		% Not sure if this might cause problems for some code.
3963		).
3964
3965		% The language mode is currently linked to the animation minor mode,
3966		% so be careful when changing it!
3967		% TODO Allow overriding the language for translate without affecting the animation mode
3968
3969		get_language_mode(csp_and(Lang)) :-
3970		csp_with_bz_mode,
3971		!,
3972		(animation_minor_mode(Lang) -> true ; Lang = b).
3973		get_language_mode(Lang) :- animation_minor_mode(Lang), !.
3974		get_language_mode(Lang) :- animation_mode(Lang).
3975
3976		set_language_mode(csp_and(Lang)) :-
3977		!,
3978		set_animation_mode(csp_and_b),
3979		(Lang == b -> true ; set_animation_minor_mode(Lang)).
3980		set_language_mode(csp) :- !, set_animation_mode(csp).
3981		set_language_mode(xtl) :- !, set_animation_mode(xtl).
3982		set_language_mode(b) :- !, set_animation_mode(b).
3983		set_language_mode(Lang) :-
3984		set_animation_mode(b),
3985		set_animation_minor_mode(Lang).
3986
3987		with_language_mode(Lang, Call) :-
3988		get_language_mode(OldLang),
3989		(OldLang == Lang -> Call ;
3990		set_language_mode(Lang),
3991		call_cleanup(Call, set_language_mode(OldLang))
3992		% FIXME This might not restore all animation modes fully!
3993		% It's apparently possible to have multiple animation minor modes,
3994		% which get/set_language_mode doesn't handle.
3995		% (Are multiple animation minor modes actually used anywhere?)
3996		).
3997
3998		exists_symbol --> {latex_mode},!, "\\exists ".
3999		exists_symbol --> {unicode_mode},!, pp_colour_code(magenta),[8707],pp_colour_code(reset).
4000		exists_symbol --> pp_colour_code(blue),"#",pp_colour_code(reset).
4001		forall_symbol --> {latex_mode},!, "\\forall ".
4002		forall_symbol --> {unicode_mode},!, pp_colour_code(magenta),[8704],pp_colour_code(reset).
4003		forall_symbol --> pp_colour_code(blue),"!",pp_colour_code(reset).
4004		dot_symbol --> {latex_mode},!, "\\cdot ".
4005		dot_symbol --> {unicode_mode},!, [183]. %"·". % dot also used in Rodin
4006		dot_symbol --> ".".
4007		dot_bullet_symbol --> {latex_mode},!, "\\cdot ".
4008		dot_bullet_symbol --> [183]. %"·". % dot also used in Rodin
4009		set_brackets(X,Y) :- latex_mode,!,X='\\{', Y='\\}'.
4010		set_brackets('{','}').
4011		left_set_bracket --> {latex_mode},!, "\\{ ".
4012		left_set_bracket --> "{".
4013		right_set_bracket --> {latex_mode},!, "\\} ".
4014		right_set_bracket --> "}".
4015		maplet_symbol --> {latex_mode},!, "\\mapsto ".
4016		maplet_symbol --> {unicode_mode},!, [8614].
4017		maplet_symbol --> "|->". % also provide option to use colours? pp_colour_code(blue) ,...
4018
4019		lambda_symbol --> {unicode_mode},!, [955]. % '\x3BB\'
4020		lambda_symbol --> {latex_mode},!, "\\lambda ".
4021		lambda_symbol --> pp_colour_code(blue),"%",pp_colour_code(reset).
4022
4023		and_symbol --> {unicode_mode},!, [8743]. % ''\x2227\''
4024		and_symbol --> {latex_mode},!, "\\wedge ".
4025		and_symbol --> "&".
4026
4027		hash_card_symbol --> {latex_mode},!, "\\# ".
4028		hash_card_symbol --> "#".
4029		ldots --> {latex_mode},!, "\\ldots ".
4030		ldots --> "...".
4031
4032		empty_set_symbol --> {get_preference(translate_print_all_sequences,true)},!, pp_empty_sequence.
4033		empty_set_symbol --> {unicode_mode},!, [8709].
4034		empty_set_symbol --> {latex_mode},!, "\\emptyset ".
4035		empty_set_symbol --> "{}".
4036
4037		underscore_symbol --> {latex_mode},!, "\\_".
4038		underscore_symbol --> "_".
4039
4040		string_start_symbol --> {latex_mode},!, "\\textnormal{``".
4041		string_start_symbol --> pp_colour_code(blue), """".
4042		string_end_symbol --> {latex_mode},!, "''}".
4043		string_end_symbol --> pp_colour_code(reset), """".
4044
4045
4046		unary_postfix_in_mode(Op,Trans2,Prio) :-
4047		unary_postfix(Op,Trans,Prio), % print(op(Op,Trans)),nl,
4048		translate_in_mode(Op,Trans,Trans2).
4049
4050		binary_infix_in_mode(Op,Trans2,Prio,Assoc) :-
4051		binary_infix(Op,Trans,Prio,Assoc), % print(op(Op,Trans)),nl,
4052		translate_in_mode(Op,Trans,Trans2).
4053
4054		latex_integer_set_translation('NATURAL', '\\mathbb N '). % \nat in bsymb.sty
4055		latex_integer_set_translation('NATURAL1', '\\mathbb N_1 '). % \natn
4056		latex_integer_set_translation('INTEGER', '\\mathbb Z '). % \intg
4057		latex_integer_set_translation('REAL', '\\mathbb R '). % \intg
4058
4059		latex_translation(empty_set, '\\emptyset ').
4060		latex_translation(implication, '\\mathbin\\Rightarrow ').
4061		latex_translation(conjunct,'\\wedge ').
4062		latex_translation(disjunct,'\\vee ').
4063		latex_translation(equivalence,'\\mathbin\\Leftrightarrow ').
4064		latex_translation(negation,'\\neg ').
4065		latex_translation(not_equal,'\\neq ').
4066		latex_translation(less_equal,'\\leq ').
4067		latex_translation(less_equal_real,'\\leq ').
4068		latex_translation(greater_equal,'\\geq ').
4069		latex_translation(member,'\\in ').
4070		latex_translation(not_member,'\\not\\in ').
4071		latex_translation(subset,'\\subseteq ').
4072		latex_translation(subset_strict,'\\subset ').
4073		latex_translation(not_subset,'\\not\\subseteq ').
4074		latex_translation(not_subset_strict,'\\not\\subset ').
4075		latex_translation(union,'\\cup ').
4076		latex_translation(intersection,'\\cap ').
4077		latex_translation(couple,'\\mapsto ').
4078		latex_translation(cartesian_product,'\\times').
4079		latex_translation(rec,'\\mathit{rec}').
4080		latex_translation(struct,'\\mathit{struct}').
4081		latex_translation(convert_bool,'\\mathit{bool}').
4082		latex_translation(max,'\\mathit{max}').
4083		latex_translation(max_real,'\\mathit{max}').
4084		latex_translation(min,'\\mathit{min}').
4085		latex_translation(min_real,'\\mathit{min}').
4086		latex_translation(modulo,'\\mod ').
4087		latex_translation(card,'\\mathit{card}').
4088		latex_translation(successor,'\\mathit{succ}').
4089		latex_translation(predecessor,'\\mathit{pred}').
4090		latex_translation(domain,'\\mathit{dom}').
4091		latex_translation(range,'\\mathit{ran}').
4092		latex_translation(size,'\\mathit{size}').
4093		latex_translation(first,'\\mathit{first}').
4094		latex_translation(last,'\\mathit{last}').
4095		latex_translation(front,'\\mathit{front}').
4096		latex_translation(tail,'\\mathit{tail}').
4097		latex_translation(rev,'\\mathit{rev}').
4098		latex_translation(seq,'\\mathit{seq}').
4099		latex_translation(seq1,'\\mathit{seq}_{1}').
4100		latex_translation(perm,'\\mathit{perm}').
4101		latex_translation(fin_subset,'\\mathit{FIN}').
4102		latex_translation(fin1_subset,'\\mathit{FIN}_{1}').
4103		latex_translation(first_projection,'\\mathit{prj}_{1}').
4104		latex_translation(second_projection,'\\mathit{prj}_{2}').
4105		latex_translation(pow_subset,'\\mathbb P\\hbox{}'). % POW \pow would require bsymb.sty
4106		latex_translation(pow1_subset,'\\mathbb P_1'). % POW1 \pown would require bsymb.sty
4107		latex_translation(concat,'\\stackrel{\\frown}{~}'). % was '\\hat{~}').
4108		latex_translation(relations,'\\mathbin\\leftrightarrow'). % <->, \rel requires bsymb.sty
4109		latex_translation(total_relation,'\\mathbin{\\leftarrow\\mkern-14mu\\leftrightarrow}'). % <<-> \trel requires bsymb.sty
4110		latex_translation(total_surjection_relation,'\\mathbin{\\leftrightarrow\\mkern-14mu\\leftrightarrow}'). % <<->> \strel requires bsymb.sty
4111		latex_translation(surjection_relation,'\\mathbin{\\leftrightarrow\\mkern-14mu\\rightarrow}'). % <->> \srel requires bsymb.sty
4112		latex_translation(partial_function,'\\mathbin{\\mkern6mu\\mapstochar\\mkern-6mu\\rightarrow}'). % +-> \pfun requires bsymb.sty, but \mapstochar is not supported by Mathjax
4113		latex_translation(partial_injection,'\\mathbin{\\mkern9mu\\mapstochar\\mkern-9mu\\rightarrowtail}'). % >+> \pinj requires bsymb.sty
4114		latex_translation(partial_surjection,'\\mathbin{\\mkern6mu\\mapstochar\\mkern-6mu\\twoheadrightarrow}'). % >+> \psur requires bsymb.sty
4115		latex_translation(total_function,'\\mathbin\\rightarrow'). % --> \tfun would require bsymb.sty
4116		latex_translation(total_surjection,'\\mathbin\\twoheadrightarrow'). % -->> \tsur requires bsymb.sty
4117		latex_translation(total_injection,'\\mathbin\\rightarrowtail'). % >-> \tinj requires bsymb.sty
4118		latex_translation(total_bijection,'\\mathbin{\\rightarrowtail\\mkern-18mu\\twoheadrightarrow}'). % >->> \tbij requires bsymb.sty
4119		latex_translation(domain_restriction,'\\mathbin\\lhd'). % <| domres requires bsymb.sty
4120		latex_translation(range_restriction,'\\mathbin\\rhd'). % |> ranres requires bsymb.sty
4121		latex_translation(domain_subtraction,'\\mathbin{\\lhd\\mkern-14mu-}'). % <<| domsub requires bsymb.sty
4122		latex_translation(range_subtraction,'\\mathbin{\\rhd\\mkern-14mu-}'). % |>> ransub requires bsymb.sty
4123		latex_translation(overwrite,'\\mathbin{\\lhd\\mkern-9mu-}'). % <+ \ovl requires bsymb.sty
4124		latex_translation(ring,'\\circ '). % not tested
4125		latex_translation(general_sum,'\\Sigma ').
4126		latex_translation(general_product,'\\Pi ').
4127		latex_translation(lambda,'\\lambda ').
4128		latex_translation(quantified_union,'\\bigcup\\nolimits'). % \Union requires bsymb.sty
4129		latex_translation(quantified_intersection,'\\bigcap\\nolimits'). % \Inter requires bsymb.sty
4130		%latex_translation(truth,'\\top').
4131		%latex_translation(falsity,'\\bot').
4132		latex_translation(truth,'{\\color{olive} \\top}'). % requires \usepackage{xcolor} in Latex
4133		latex_translation(falsity,'{\\color{red} \\bot}').
4134		latex_translation(boolean_true,'{\\color{olive} \\mathit{TRUE}}').
4135		latex_translation(boolean_false,'{\\color{red} \\mathit{FALSE}}').
4136		latex_translation(pred_true,'{\\color{olive} \\mathit{TRUE}}').
4137		latex_translation(pred_false,'{\\color{red} \\mathit{FALSE}}').
4138		latex_translation(reverse,'^{-1}').
4139
4140		ascii_to_unicode(Ascii,Unicode) :-
4141		translate_prolog_constructor(BAst,Ascii), % will not backtrack
4142		unicode_translation(BAst,Unicode).
4143
4144
4145		% can be used to translate Latex shortcuts to B Unicode operators for editors
4146		latex_to_unicode(LatexShortcut,Unicode) :-
4147		latex_to_b_ast(LatexShortcut,BAst),
4148		unicode_translation(BAst,Unicode).
4149		latex_to_unicode(LatexShortcut,Unicode) :- % allow to use B AST names as well
4150		unicode_translation(LatexShortcut,Unicode).
4151		latex_to_unicode(LatexShortcut,Unicode) :-
4152		greek_symbol(LatexShortcut,Unicode).
4153
4154		get_latex_keywords(List) :-
4155		findall(Id,latex_to_unicode(Id,_),Ids),
4156		sort(Ids,List).
4157
4158		get_latex_keywords_with_backslash(BList) :-
4159		get_latex_keywords(List),
4160		maplist(atom_concat('\\'),List,BList).
4161
4162		latex_to_b_ast(and,conjunct).
4163		latex_to_b_ast(bcomp,ring). % bsymb: backwards composition
4164		latex_to_b_ast(bigcap,quantified_intersection).
4165		latex_to_b_ast(bigcup,quantified_union).
4166		latex_to_b_ast(cap,intersection).
4167		latex_to_b_ast(cart,cartesian_product).
4168		latex_to_b_ast(cprod,cartesian_product).
4169		latex_to_b_ast(cdot,dot_symbol).
4170		latex_to_b_ast(cup,union).
4171		latex_to_b_ast(dprod,direct_product).
4172		latex_to_b_ast(dres,domain_restriction).
4173		latex_to_b_ast(dsub,domain_subtraction).
4174		latex_to_b_ast(emptyset,empty_set).
4175		latex_to_b_ast(exp,power_of).
4176		%latex_to_b_ast(fcomp,composition). % bsymb: forwards composition
4177		latex_to_b_ast(geq,greater_equal).
4178		latex_to_b_ast(implies,implication).
4179		latex_to_b_ast(in,member).
4180		latex_to_b_ast(int,'INTEGER').
4181		latex_to_b_ast(intg,'INTEGER'). % from bsymb
4182		latex_to_b_ast(lambda,lambda).
4183		latex_to_b_ast(land,conjunct).
4184		latex_to_b_ast(leq,less_equal).
4185		latex_to_b_ast(leqv,equivalence).
4186		latex_to_b_ast(lhd,domain_restriction).
4187		latex_to_b_ast(limp,implication).
4188		latex_to_b_ast(lor,disjunct).
4189		latex_to_b_ast(lnot,negation).
4190		latex_to_b_ast(mapsto,couple).
4191		latex_to_b_ast(nat,'NATURAL').
4192		latex_to_b_ast(natn,'NATURAL1').
4193		latex_to_b_ast(neg,negation).
4194		latex_to_b_ast(neq,not_equal).
4195		latex_to_b_ast(nin,not_member).
4196		latex_to_b_ast(not,negation).
4197		latex_to_b_ast(nsubseteq,not_subset).
4198		latex_to_b_ast(nsubset,not_subset_strict).
4199		latex_to_b_ast(or,disjunct).
4200		%latex_to_b_ast(ovl,overwrite).
4201		latex_to_b_ast(pfun,partial_function).
4202		latex_to_b_ast(pinj,partial_injection).
4203		latex_to_b_ast(psur,partial_surjection).
4204		latex_to_b_ast(pow,pow_subset).
4205		latex_to_b_ast(pown,pow1_subset).
4206		latex_to_b_ast(pprod,parallel_product).
4207		latex_to_b_ast(qdot,dot_symbol).
4208		latex_to_b_ast(real,'REAL').
4209		latex_to_b_ast(rel,relations).
4210		latex_to_b_ast(rhd,range_restriction).
4211		latex_to_b_ast(rres,range_restriction).
4212		latex_to_b_ast(rsub,range_subtraction).
4213		latex_to_b_ast(srel,surjection_relation).
4214		latex_to_b_ast(subseteq,subset).
4215		latex_to_b_ast(subset,subset_strict).
4216		latex_to_b_ast(tbij,total_bijection).
4217		latex_to_b_ast(tfun,total_function).
4218		latex_to_b_ast(tinj,total_injection).
4219		latex_to_b_ast(trel,total_relation).
4220		latex_to_b_ast(tsrel,total_surjection_relation).
4221		latex_to_b_ast(tsur,total_surjection).
4222		latex_to_b_ast(upto,interval).
4223		latex_to_b_ast(vee,disjunct).
4224		latex_to_b_ast(wedge,conjunct).
4225		latex_to_b_ast('INT','INTEGER').
4226		latex_to_b_ast('NAT','NATURAL').
4227		latex_to_b_ast('N','NATURAL').
4228		latex_to_b_ast('Pi',general_product).
4229		latex_to_b_ast('POW',pow_subset).
4230		latex_to_b_ast('REAL','REAL').
4231		latex_to_b_ast('Rightarrow',implication).
4232		latex_to_b_ast('Sigma',general_sum).
4233		latex_to_b_ast('Leftrightarrow',equivalence).
4234		latex_to_b_ast('Inter',quantified_intersection).
4235		latex_to_b_ast('Union',quantified_union).
4236		latex_to_b_ast('Z','INTEGER').
4237
4238		unicode_translation(implication, '\x21D2\').
4239		unicode_translation(conjunct,'\x2227\').
4240		unicode_translation(disjunct,'\x2228\').
4241		unicode_translation(negation,'\xAC\').
4242		unicode_translation(equivalence,'\x21D4\').
4243		unicode_translation(not_equal,'\x2260\').
4244		unicode_translation(less_equal,'\x2264\').
4245		unicode_translation(less_equal_real,'\x2264\').
4246		unicode_translation(greater_equal,'\x2265\').
4247		unicode_translation(member,'\x2208\').
4248		unicode_translation(not_member,'\x2209\').
4249		unicode_translation(subset,'\x2286\').
4250		unicode_translation(subset_strict,'\x2282\').
4251		unicode_translation(not_subset,'\x2288\').
4252		unicode_translation(not_subset_strict,'\x2284\').
4253		unicode_translation(supseteq,'\x2287\'). % ProB parser supports unicode symbol by reversing arguments
4254		unicode_translation(supset_strict,'\x2283\'). % ditto
4255		unicode_translation(not_supseteq,'\x2289\'). % ditto
4256		unicode_translation(not_supset_strict,'\x2285\'). % ditto
4257		unicode_translation(union,'\x222A\').
4258		unicode_translation(intersection,'\x2229\').
4259		unicode_translation(cartesian_product,'\xD7\'). % also 0x2217 in Camille or 0x2A2F (vector or cross product) in IDP
4260		unicode_translation(couple,'\x21A6\').
4261		unicode_translation(div,'\xF7\').
4262		unicode_translation(dot_symbol,'\xB7\'). % not a B AST operator, cf dot_symbol 183
4263		unicode_translation(floored_div,'\xF7\') :-
4264		animation_minor_mode(tla). % should we provide another Unicode character here for B?
4265		unicode_translation(power_of,'\x02C4\'). % version of ^, does not exist in Rodin ?!, upwards arrow x2191 used below for restrict front
4266		unicode_translation(power_of_real,'\x02C4\').
4267		unicode_translation(interval,'\x2025\').
4268		unicode_translation(domain_restriction,'\x25C1\').
4269		unicode_translation(domain_subtraction,'\x2A64\').
4270		unicode_translation(range_restriction,'\x25B7\').
4271		unicode_translation(range_subtraction,'\x2A65\').
4272		unicode_translation(relations,'\x2194\').
4273		unicode_translation(partial_function,'\x21F8\').
4274		unicode_translation(total_function,'\x2192\').
4275		unicode_translation(partial_injection,'\x2914\').
4276		unicode_translation(partial_surjection,'\x2900\').
4277		unicode_translation(total_injection,'\x21A3\').
4278		unicode_translation(total_surjection,'\x21A0\').
4279		unicode_translation(total_bijection,'\x2916\').
4280		unicode_translation('INTEGER','\x2124\').
4281		unicode_translation('NATURAL','\x2115\').
4282		unicode_translation('NATURAL1','\x2115\\x2081\'). % \x2115\ is subscript 1
4283		unicode_translation('REAL','\x211D\'). % 8477 in decimal
4284		unicode_translation(real_set,'\x211D\').
4285		%unicode_translation(bool_set,'\x1D539\'). % conversion used by IDP, but creates SPIO_E_ENCODING_INVALID problem
4286		unicode_translation(pow_subset,'\x2119\').
4287		unicode_translation(pow1_subset,'\x2119\\x2081\'). % \x2115\ is subscript 1
4288		unicode_translation(lambda,'\x3BB\').
4289		unicode_translation(general_product,'\x220F\').
4290		unicode_translation(general_sum,'\x2211\').
4291		unicode_translation(quantified_union,'\x22C3\'). % 8899 in decimal
4292		unicode_translation(quantified_intersection,'\x22C2\'). % 8898 in decimal
4293		unicode_translation(empty_set,'\x2205\').
4294		unicode_translation(truth,'\x22A4\'). % 8868 in decimal
4295		unicode_translation(falsity,'\x22A5\'). % 8869 in decimal
4296		unicode_translation(direct_product,'\x2297\').
4297		unicode_translation(parallel_product,'\x2225\').
4298		unicode_translation(reverse,'\x207B\\xB9\') :- \+ force_eventb_rodin_mode. % the one ¹ is ASCII 185
4299		% this symbol is not accepted by Rodin
4300		% unicode_translation(infinity,'\x221E\'). % 8734 in decimal
4301		unicode_translation(concat,'\x2312\'). % Arc character
4302		unicode_translation(insert_front,'\x21FE\').
4303		unicode_translation(insert_tail,'\x21FD\').
4304		unicode_translation(restrict_front,'\x2191\'). % up arrow
4305		unicode_translation(restrict_tail,'\x2192\').
4306		unicode_translation(forall, '\x2200\'). % usually forall_symbol used
4307		unicode_translation(exists, '\x2203\'). % usually exists_symbol used
4308		unicode_translation(eqeq,'\x225c\').
4309
4310		%unicode_translation(overwrite,'\xE103\'). % from kernel_lang_20.pdf
4311		unicode_translation(ring,'\x2218\'). % from Event-B
4312		unicode_translation(typeof,'\x2982\'). % Event-B oftype operator
4313
4314		% see Chapter 3 of Atelier-B prover manual:
4315		%atelierb_pp_translation(E,PP,_) :- write(pp(PP,E)),nl,fail.
4316		atelierb_pp_translation(set_minus,pp,'_moinsE'). % is set_subtraction ??
4317		atelierb_pp_translation(cartesian_product,pp,'_multE').
4318		atelierb_pp_translation('INTEGER',_,'INTEGER').
4319		%atelierb_pp_translation('INT','(MININT..MAXINT)'). % does not seem necessary
4320		atelierb_pp_translation('NATURAL',_,'NATURAL').
4321		atelierb_pp_translation('NATURAL1',_,'(NATURAL - {0})').
4322		atelierb_pp_translation('NAT1',_,'(NAT - {0})').
4323		%atelierb_pp_translation('NAT','(0..MAXINT)'). % does not seem necessary
4324		%atelierb_pp_translation('NAT1','(1..MAXINT)'). % does not seem necessary
4325		atelierb_pp_translation(truth,_,btrue).
4326		atelierb_pp_translation(falsity,_,bfalse).
4327		atelierb_pp_translation(boolean_true,_,'TRUE').
4328		atelierb_pp_translation(boolean_false,_,'FALSE').
4329		atelierb_pp_translation(empty_sequence,_,'{}').
4330
4331
4332
4333		quantified_in_mode(F,S) :-
4334		quantified(F,S1), translate_in_mode(F,S1,S).
4335
4336		translate_in_mode(F,S1,Result) :-
4337		( unicode_mode, unicode_translation(F,S) -> true
4338		; latex_mode, latex_translation(F,S) -> true
4339		; atelierb_mode(prover(PPML)), atelierb_pp_translation(F,PPML,S) -> true
4340		; colour_translation(F,S1,S) -> true
4341		; S1=S),
4342		(colour_translation(F,S,Res) -> Result=Res ; Result=S).
4343
4344		:- use_module(tools_printing,[get_terminal_colour_code/2, no_color/0]).
4345		use_colour_codes :- \+ no_color,
4346		get_preference(pp_with_terminal_colour,true).
4347		colour_translation(F,S1,Result) :- use_colour_codes,
4348		colour_construct(F,Colour),!,
4349		get_terminal_colour_code(Colour,R1),
4350		get_terminal_colour_code(reset,R2),
4351		ajoin([R1,S1,R2],Result).
4352		colour_construct(pred_true,green).
4353		colour_construct(pred_false,red).
4354		colour_construct(boolean_true,green).
4355		colour_construct(boolean_false,red).
4356		colour_construct(truth,green).
4357		colour_construct(falsity,red).
4358		colour_construct(_,blue).
4359
4360		% pretty print a colour code if colours are enabled:
4361		pp_colour_code(Colour) --> {use_colour_codes,get_terminal_colour_code(Colour,C), atom_codes(C,CC)},!,CC.
4362		pp_colour_code(_) --> [].
4363
4364
4365		quantified(general_sum,'SIGMA').
4366		quantified(general_product,'PI').
4367		quantified(quantified_union,'UNION').
4368		quantified(quantified_intersection,'INTER').
4369		quantified(lambda,X) :- atom_codes(X,[37]).
4370		quantified(forall,'!').
4371		quantified(exists,'#').
4372
4373
4374		translate_prolog_constructor(C,R) :- unary_prefix(C,R,_),!.
4375		translate_prolog_constructor(C,R) :- unary_postfix(C,R,_),!.
4376		translate_prolog_constructor(C,R) :- binary_infix_in_mode(C,R,_,_),!.
4377		translate_prolog_constructor(C,R) :- function_like_in_mode(C,R),!.
4378		translate_prolog_constructor(C,R) :- constants_in_mode(C,R),!.
4379		translate_prolog_constructor(C,R) :- quantified_in_mode(C,R),!.
4380
4381		% translate the Prolog constuctor of an AST node into a form for printing to the user
4382		translate_prolog_constructor_in_mode(Constructor,Result) :-
4383		unicode_mode,
4384		unicode_translation(Constructor,Unicode),!, Result=Unicode.
4385		translate_prolog_constructor_in_mode(Constructor,Result) :-
4386		latex_mode,
4387		latex_translation(Constructor,Latex),!, Result=Latex.
4388		translate_prolog_constructor_in_mode(C,R) :- translate_prolog_constructor(C,R).
4389
4390		translate_subst_or_bexpr_in_mode(Mode,TExpr,String) :-
4391		with_translation_mode(Mode, translate_subst_or_bexpr(TExpr,String)).
4392
4393
4394		translate_bexpression_to_unicode(TExpr,String) :-
4395		with_translation_mode(unicode, translate_bexpression(TExpr,String)).
4396
4397		translate_bexpression(TExpr,String) :-
4398		(pp_expr(TExpr,String) -> true
4399		; add_error(translate_bexpression,'Could not translate bexpression: ',TExpr),String='???').
4400
4401		translate_bexpression_to_codes(TExpr,Codes) :-
4402		reset_pp,
4403		pp_expr(TExpr,_,_LimitReached,Codes,[]).
4404
4405		pp_expr(TExpr,String) :-
4406		translate_bexpression_to_codes(TExpr,Codes),
4407		atom_codes_with_limit(String, Codes).
4408
4409		translate_bexpression_with_limit(T,S) :- translate_bexpression_with_limit(T,200,report_errors,S).
4410		translate_bexpression_with_limit(TExpr,Limit,String) :-
4411		translate_bexpression_with_limit(TExpr,Limit,report_errors,String).
4412		translate_bexpression_with_limit(TExpr,Limit,report_errors,String) :- compound(String),!,
4413		add_internal_error('Result is instantiated to a compound term:',
4414		translate_bexpression_with_limit(TExpr,Limit,report_errors,String)),fail.
4415		translate_bexpression_with_limit(TExpr,Limit,ReportErrors,String) :-
4416		(catch_call(pp_expr_with_limit(TExpr,Limit,String)) -> true
4417		; (ReportErrors=report_errors,
4418		add_error(translate_bexpression,'Could not translate bexpression: ',TExpr),String='???')).
4419
4420		pp_expr_with_limit(TExpr,Limit,String) :-
4421		set_up_limit_reached(Codes,Limit,LimitReached),
4422		reset_pp,
4423		pp_expr(TExpr,_,LimitReached,Codes,[]),
4424		atom_codes_with_limit(String, Limit, Codes).
4425
4426
4427
4428		% pretty-type an expression, if the expression has a priority >MinPrio, parenthesis
4429		% can be ommitted, if not the expression has to be put into parenthesis
4430		pp_expr_m(TExpr,MinPrio,LimitReached,S,Srest) :-
4431		add_outer_paren(Prio,MinPrio,S,Srest,X,Xrest), % use co-routine to instantiate S as soon as possible
4432		pp_expr(TExpr,Prio,LimitReached,X,Xrest).
4433
4434		:- block add_outer_paren(-,?,?,?,?,?).
4435		add_outer_paren(Prio,MinPrio,S,Srest,X,Xrest) :-
4436		( Prio > MinPrio -> % was >=, but problem with & / or with same priority or with non associative operators !
4437		S=X, Srest=Xrest
4438		;
4439		[Open] = "(", [Close] = ")",
4440		S = [Open|X], Xrest = [Close|Srest]).
4441		% warning: if prio not set we will have a pending co-routine and instantiation_error in atom_codes later
4442
4443		:- use_module(translate_keywords,[classical_b_keyword/1, translate_keyword_id/2]).
4444		translated_identifier('_zzzz_binary',R) :- !,
4445		(latex_mode -> R='z''''' ; R='z__'). % TO DO: could cause clash with user IDs
4446		translated_identifier('_zzzz_unary',R) :- !,
4447		(latex_mode -> R='z''' ; R='z_'). % TO DO: ditto
4448		translated_identifier('__RANGE_LAMBDA__',R) :- !,
4449		(latex_mode -> R='\\rho\'' ; unicode_mode -> R= '\x03c1\' % RHO
4450		; R = 'RANGE_LAMBDA__'). %ditto, could clash with user IDs !!
4451		% TO DO: do we need to treat _prj_arg1__, _prj_arg2__, _lambda_result_ here ?
4452		translated_identifier(ID,Result) :-
4453		latex_mode,!,
4454		my_greek_latex_escape_atom(ID,Greek,Res), %print_message(translate_latex(ID,Greek,Res)),
4455		(Greek=greek -> Result = Res ; ajoin(['\\mathit{',Res,'}'],Result)).
4456		translated_identifier(X,X).
4457
4458		pp_identifier(Atom) --> {id_requires_escaping(Atom), \+ eventb_translation_mode, \+ latex_mode}, !,
4459		({atelierb_mode(_)}
4460		-> pp_identifier_for_atelierb(Atom)
4461		; pp_backquoted_identifier(Atom)
4462		).
4463		pp_identifier(Atom) --> ppatom_opt_scramble(Atom).
4464
4465		% print atom using backquotes, we use same escaping rules as in a string
4466		% requires B parser version 2.9.30 or newer
4467		pp_backquoted_identifier(Atom) --> {atom_codes(Atom,Codes)}, pp_backquoted_id_codes(Codes).
4468		pp_backquoted_id_codes(Codes) --> {append(Prefix,[0'. | Suffix],Codes), Suffix=[_|_]},
4469		!, % we need to split the id and quote each part separately; otherwise the parser will complain
4470		% see issue https://github.com/hhu-stups/prob-issues/issues/321
4471		% However, ids with dots are not accepted for constants and variables; so this does not solve all problems
4472		"`", pp_codes_opt_scramble(Prefix), "`.", % TODO: we could check if id_requires_escaping
4473		pp_backquoted_id_codes(Suffix).
4474		pp_backquoted_id_codes(Codes) --> "`", pp_codes_opt_scramble(Codes), "`".
4475
4476		:- use_module(tools_strings,[is_simple_classical_b_identifier/1]).
4477		id_requires_escaping(ID) :- classical_b_keyword(ID).
4478		id_requires_escaping(ID) :- \+ is_simple_classical_b_identifier(ID).
4479
4480		pp_identifier_for_atelierb(Atom) -->
4481		{atom_codes(Atom,Codes),
4482		strip_illegal_id_codes(Codes,Change,Codes2),
4483		Change==true},!,
4484		{atom_codes(A2,Codes2)},
4485		ppatom_opt_scramble(A2).
4486		pp_identifier_for_atelierb(Atom) --> ppatom_opt_scramble(Atom).
4487
4488		% remove illegal codes in an identifier (probably EventB or Z)
4489		strip_illegal_id_codes([0'_ | T ],Change,[946 | TR]) :- !, Change=true, strip_illegal_id_codes(T,_,TR).
4490		strip_illegal_id_codes(Codes,Change,Res) :- strip_illegal_id_codes2(Codes,Change,Res).
4491
4492		strip_illegal_id_codes2([],_,[]).
4493		strip_illegal_id_codes2([H|T],Change,Res) :- strip_code(H,Res,TR),!, Change=true, strip_illegal_id_codes2(T,_,TR).
4494		strip_illegal_id_codes2([H|T],Change,[H|TR]) :- strip_illegal_id_codes2(T,Change,TR).
4495
4496		strip_code(46,[0'_, 0'_ |T],T). % replace dot . by two underscores
4497		strip_code(36,[946|T],T) :- T \= [48]. % replace dollar $ by beta unless it is $0 at the end
4498		strip_code(92,[950|T],T). % replace dollar by zeta; probably from Zed
4499		% TODO: add more symbols and ensure that the new codes do not exist
4500
4501
4502
4503		:- use_module(tools,[latex_escape_atom/2]).
4504
4505		greek_or_math_symbol(Symbol) :- greek_symbol(Symbol,_).
4506		% other Latex math symbols
4507		greek_or_math_symbol('varepsilon').
4508		greek_or_math_symbol('varphi').
4509		greek_or_math_symbol('varpi').
4510		greek_or_math_symbol('varrho').
4511		greek_or_math_symbol('varsigma').
4512		greek_or_math_symbol('vartheta').
4513		greek_or_math_symbol('vdash').
4514		greek_or_math_symbol('models').
4515
4516		greek_symbol('Alpha','\x0391\').
4517		greek_symbol('Beta','\x0392\').
4518		greek_symbol('Chi','\x03A7\').
4519		greek_symbol('Delta','\x0394\').
4520		greek_symbol('Epsilon','\x0395\').
4521		greek_symbol('Eta','\x0397\').
4522		greek_symbol('Gamma','\x0393\').
4523		greek_symbol('Iota','\x0399\').
4524		greek_symbol('Kappa','\x039A\').
4525		greek_symbol('Lambda','\x039B\').
4526		greek_symbol('Mu','\x039C\').
4527		greek_symbol('Nu','\x039D\').
4528		greek_symbol('Phi','\x03A6\').
4529		greek_symbol('Pi','\x03A0\').
4530		greek_symbol('Psi','\x03A8\').
4531		greek_symbol('Rho','\x03A1\').
4532		greek_symbol('Omega','\x03A9\').
4533		greek_symbol('Omicron','\x039F\').
4534		greek_symbol('Sigma','\x03A3\').
4535		greek_symbol('Theta','\x0398\').
4536		greek_symbol('Upsilon','\x03A5\').
4537		greek_symbol('Xi','\x039E\').
4538		greek_symbol('alpha','\x03B1\').
4539		greek_symbol('beta','\x03B2\').
4540		greek_symbol('delta','\x03B4\').
4541		greek_symbol('chi','\x03C7\').
4542		greek_symbol('epsilon','\x03B5\').
4543		greek_symbol('eta','\x03B7\').
4544		greek_symbol('gamma','\x03B3\').
4545		greek_symbol('iota','\x03B9\').
4546		greek_symbol('kappa','\x03BA\').
4547		greek_symbol('lambda','\x03BB\').
4548		greek_symbol('mu','\x03BC\').
4549		greek_symbol('nu','\x03BD\').
4550		greek_symbol('omega','\x03C9\').
4551		greek_symbol('omicron','\x03BF\').
4552		greek_symbol('pi','\x03C0\').
4553		greek_symbol('phi','\x03C6\').
4554		greek_symbol('psi','\x03C8\').
4555		greek_symbol('rho','\x03C1\').
4556		greek_symbol('sigma','\x03C3\').
4557		greek_symbol('tau','\x03C4\').
4558		greek_symbol('theta','\x03B8\').
4559		greek_symbol('upsilon','\x03C5\').
4560		greek_symbol('xi','\x03BE\').
4561		greek_symbol('zeta','\x03B6\').
4562
4563
4564		my_greek_latex_escape_atom(A,greek,Res) :-
4565		greek_or_math_symbol(A),get_preference(latex_pp_greek_ids,true),!,
4566		atom_concat('\\',A,Res).
4567		my_greek_latex_escape_atom(A,no_greek,EA) :- latex_escape_atom(A,EA).
4568
4569		% ppatom + scramble if BUGYLY is TRUE
4570		ppatom_opt_scramble(Name) --> {get_preference(bugly_pp_scrambling,true)},
4571		% {\+ bmachine:b_top_level_operation(Name)}, % comment in to not change name of B operations
4572		!,
4573		{bugly_scramble_id(Name,ScrName)},
4574		ppatom(ScrName).
4575		ppatom_opt_scramble(Name) -->
4576		{primes_to_unicode(Name, UnicodeName)},
4577		pp_atom_opt_latex(UnicodeName).
4578
4579		% Convert ASCII primes (apostrophes) in identifiers to Unicode primes
4580		% so they can be parsed by the classical B parser.
4581		primes_to_unicode(Name, UnicodeName) :-
4582		atom_codes(Name, Codes),
4583		phrase(primes_to_unicode(Codes), UCodes),
4584		atom_codes(UnicodeName, UCodes).
4585		primes_to_unicode([0'\'|T]) --> !,
4586		"\x2032\",
4587		primes_to_unicode(T).
4588		primes_to_unicode([C|T]) --> !,
4589		[C],
4590		primes_to_unicode(T).
4591		primes_to_unicode([]) --> "".
4592
4593		:- use_module(tools,[b_string_escape_codes/2]).
4594		:- use_module(tools_strings,[convert_atom_to_number/2]).
4595		% a version of ppatom which encodes/quotes symbols inside strings such as quotes "
4596		ppstring_opt_scramble(Name) --> {var(Name)},!,ppatom(Name).
4597		ppstring_opt_scramble(Name) --> {compound(Name)},!,
4598		{add_internal_error('Not an atom: ',ppstring_opt_scramble(Name,_,_))},
4599		"<<" ,ppterm(Name), ">>".
4600		ppstring_opt_scramble(Name) --> {get_preference(bugly_pp_scrambling,true)},!,
4601		pp_bugly_composed_string(Name).
4602		ppstring_opt_scramble(Name) --> {atom_codes(Name,Codes),b_string_escape_codes(Codes,EscCodes)},
4603		pp_codes_opt_latex(EscCodes).
4604
4605		% a version of ppstring_opt_scramble with codes list
4606		pp_codes_opt_scramble(Codes) --> {get_preference(bugly_pp_scrambling,true)},!,
4607		pp_bugly_composed_string_codes(Codes,[]).
4608		pp_codes_opt_scramble(Codes) --> {b_string_escape_codes(Codes,EscCodes)},
4609		pp_codes_opt_latex(EscCodes).
4610
4611		pp_bugly_composed_string(Name) --> {atom_codes(Name,Codes)},
4612		!, % we can decompose the string; scramble each string separately; TODO: provide option to define separators
4613		% idea is that if we have a string with spaces or other special separators we preserve the separators
4614		pp_bugly_composed_string_codes(Codes,[]).
4615
4616		pp_bugly_composed_string_codes([],Acc) --> {atom_codes(Atom,Acc)}, pp_bugly_string(Atom).
4617		pp_bugly_composed_string_codes(List,Acc) --> {decompose_string(List,Seps,T)},!,
4618		{reverse(Acc,Rev),atom_codes(Atom,Rev)}, pp_bugly_string(Atom),
4619		ppcodes(Seps),
4620		pp_bugly_composed_string_codes(T,[]).
4621		pp_bugly_composed_string_codes([H|T],Acc) --> pp_bugly_composed_string_codes(T,[H|Acc]).
4622
4623		decompose_string([Sep|T],[Sep],T) :- bugly_separator(Sep).
4624		% comment in and adapt for domain specific separators:
4625		%decompose_string(List,Seps,T) :- member(Seps,["LEU","DEF","BAL"]), append(Seps,T,List).
4626		%bugly_separator(10).
4627		%bugly_separator(13).
4628		bugly_separator(32).
4629		bugly_separator(0'-).
4630		bugly_separator(0'_).
4631		bugly_separator(0',).
4632		bugly_separator(0'.).
4633		bugly_separator(0';).
4634		bugly_separator(0':).
4635		bugly_separator(0'#).
4636		bugly_separator(0'[).
4637		bugly_separator(0']).
4638		bugly_separator(0'().
4639		bugly_separator(0')).
4640
4641		% scramble and pretty print individual strings or components of strings
4642		pp_bugly_string('') --> !, [].
4643		pp_bugly_string(Name) -->
4644		{convert_atom_to_number(Name,_)},!, % do not scramble numbers; we could check if LibraryStrings is available
4645		pp_atom_opt_latex(Name).
4646		pp_bugly_string(Name) -->
4647		{bugly_scramble_id(Name,ScrName)},
4648		ppatom(ScrName).
4649
4650		% ------------
4651
4652		pp_atom_opt_latex(Name) --> {latex_mode},!,
4653		{my_greek_latex_escape_atom(Name,_,EscName)},
4654		% should we add \mathrm{.} or \mathit{.}?
4655		ppatom(EscName).
4656		pp_atom_opt_latex(Name) --> ppatom(Name).
4657
4658		% a version of pp_atom_opt_latex working with codes
4659		pp_codes_opt_latex(Codes) --> {latex_mode},!,
4660		{atom_codes(Name,Codes),my_greek_latex_escape_atom(Name,_,EscName)},
4661		ppatom(EscName).
4662		pp_codes_opt_latex(Codes) --> ppcodes(Codes).
4663
4664		pp_atom_opt_latex_mathit(Name) --> {latex_mode},!,
4665		{latex_escape_atom(Name,EscName)},
4666		"\\mathit{",ppatom(EscName),"}".
4667		pp_atom_opt_latex_mathit(Name) --> ppatom(Name).
4668
4669		pp_atom_opt_mathit(EscName) --> {latex_mode},!,
4670		% we assume already escaped
4671		"\\mathit{",ppatom(EscName),"}".
4672		pp_atom_opt_mathit(Name) --> ppatom(Name).
4673
4674		pp_space --> {latex_mode},!, "\\ ".
4675		pp_space --> " ".
4676
4677		opt_scramble_id(ID,Res) :- get_preference(bugly_pp_scrambling,true),!,
4678		bugly_scramble_id(ID,Res).
4679		opt_scramble_id(ID,ID).
4680
4681		:- use_module(probsrc(gensym),[gensym/2]).
4682		:- dynamic bugly_scramble_id_cache/2.
4683		bugly_scramble_id(ID,Res) :- var(ID),!, add_internal_error('Illegal call: ',bugly_scramble_id(ID,Res)), ID=Res.
4684		bugly_scramble_id(ID,Res) :- bugly_scramble_id_cache(ID,ScrambledID),!,
4685		Res=ScrambledID.
4686		bugly_scramble_id(ID,Res) :- %print(gen_id(ID,Res)),nl,
4687		genbuglynr(Nr),
4688		gen_bugly_id(Nr,ScrambledID),
4689		assertz(bugly_scramble_id_cache(ID,ScrambledID)),
4690		%format(user_output,'BUGLY scramble ~w --> ~w~n',[ID,ScrambledID]),
4691		Res = ScrambledID.
4692
4693		gen_bugly_id_codes(Nr,[Char|TC]) :- Char is 97+ Nr mod 26,
4694		(Nr> 25 -> N1 is Nr // 26, gen_bugly_id_codes(N1,TC) ; TC=[]).
4695		gen_bugly_id(Nr,ScrambledID) :- gen_bugly_id_codes(Nr,Codes), atom_codes(ScrambledID,[97,97|Codes]).
4696		%gen_bugly_id(Nr,ScrambledID) :- ajoin(['aa',Nr],ScrambledID). % old version using aaNr
4697
4698		:- dynamic bugly_count/1.
4699		bugly_count(0).
4700		genbuglynr(Nr) :-
4701		retract(bugly_count(Nr)), N1 is Nr + 1,
4702		assertz(bugly_count(N1)).
4703
4704
4705		is_lambda_result_id(b(identifier(ID),_,_INFO),Suffix) :- % _INFO=[lambda_result], sometiems _INFO=[]
4706		is_lambda_result_name(ID,Suffix).
4707		is_lambda_result_name(LAMBDA_RESULT,Suffix) :- atomic(LAMBDA_RESULT),
4708		atom_codes(LAMBDA_RESULT,[95,108,97,109,98,100,97,95,114,101,115,117,108,116,95|Suffix]). % _lambda_result_
4709
4710		pp_expr(TE,P) --> %{print('OBSOLETE'),nl,nl},
4711		pp_expr(TE,P,_LimitReached).
4712
4713		pp_expr(TExpr,Prio,_) --> {var(TExpr)},!,"_",{Prio=500}.
4714		pp_expr(_,Prio,LimitReached) --> {LimitReached==limit_reached},!,"...",{Prio=500}.
4715		pp_expr(b(Expr,Type,Info),Prio,LimitReached) --> !,
4716		pp_expr0(Expr,Type,Info,Prio,LimitReached).
4717		pp_expr(Expr,Prio,LimitReached) -->
4718		pp_expr1(Expr,any,[],Prio,LimitReached).
4719
4720		pp_expr0(identifier(ID),_Type,_Info,Prio,_LimitReached) --> {is_lambda_result_name(ID,Suffix)},!, {Prio=500},
4721		{append("LAMBDA_RESULT___",Suffix,ASCII), atom_codes(R,ASCII)}, ppatom(R).
4722		pp_expr0(Expr,_Type,Info,Prio,_LimitReached) -->
4723		{eventb_translation_mode},
4724		pp_theory_operator(Expr,Info,Prio),!.
4725		pp_expr0(Expr,Type,Info,Prio,LimitReached) -->
4726		{check_info(Expr,Type,Info)},
4727		pp_rodin_label(Info),
4728		(pp_expr1(Expr,Type,Info,Prio,LimitReached) -> {true}
4729		; {add_error(translate,'Could not translate:',Expr,Expr),fail}
4730		).
4731
4732		check_info(Expr,_,Info) :- var(Info), add_error(translate,'Illegal variable info field for expression: ', Expr),fail.
4733		check_info(_,_,_).
4734
4735		pp_theory_operator(general_sum(_,Membercheck,_),_Info,500) -->
4736		{get_texpr_expr(Membercheck,member(_,Arg))},
4737		ppatom('SUM('),pp_expr(Arg,_),ppatom(')').
4738		pp_theory_operator(general_product(_,Membercheck,_),_Info,500) -->
4739		{get_texpr_expr(Membercheck,member(_Couple,Arg))},
4740		ppatom('PRODUCT('),pp_expr(Arg,_),ppatom(')').
4741		pp_theory_operator(function(_,Arg),Info,500) -->
4742		{memberchk_in_info(theory_operator(O,N),Info),decouplise_expr(N,Arg,Args)},
4743		ppatom(O),"(",pp_expr_l_sep(Args,",",_LR),")".
4744		pp_theory_operator(member(Arg,_),Info,500) -->
4745		{memberchk_in_info(theory_operator(O,N),Info),decouplise_expr(N,Arg,Args)},
4746		ppatom(O),"(",pp_expr_l_sep(Args,",",_LR),")".
4747
4748		decouplise_expr(1,E,R) :- !,R=[E].
4749		decouplise_expr(N,E,R) :-
4750		get_texpr_expr(E,couple(A,B)),!,
4751		N2 is N-1,
4752		decouplise_expr(N2,A,R1),append(R1,[B],R).
4753		decouplise_expr(N,E,[E]) :-
4754		print_message(call_failed(decouplise_expr(N,E,_))),nl.
4755
4756		% will pretty print (first) rodin or pragma label
4757		pp_rodin_label(_Infos) --> {preference(translate_suppress_rodin_positions_flag,true),!}.
4758		pp_rodin_label(_Infos) --> {preference(bugly_pp_scrambling,true),!}.
4759		pp_rodin_label(Infos) --> {var(Infos)},!, "/* ILLEGAL VARIABLE INFO FIELD */".
4760		pp_rodin_label(Infos) --> {get_info_labels(Infos,Label)},!,
4761		pp_start_label_pragma,
4762		ppatoms_opt_latex(Label),
4763		pp_end_label_pragma.
4764		pp_rodin_label(Infos) --> {preference(pp_wd_infos,true)},!, pp_wd_info(Infos).
4765		pp_rodin_label(_Infos) --> [].
4766
4767		% print infos about well-definedness attached to AST node:
4768		pp_wd_info(Infos) --> {member(discharged_wd_po,Infos)},!, "/*D",
4769		({member(contains_wd_condition,Infos)} -> "-WD*/ " ; "*/ ").
4770		pp_wd_info(Infos) --> {member(contains_wd_condition,Infos)},!, "/*WD*/ ".
4771		pp_wd_info(_Infos) --> [].
4772
4773		pp_start_label_pragma -->
4774		{(atelierb_mode(prover(_))
4775		; get_preference(translate_print_typing_infos,true))}, % proxy for parseable;
4776		% set by translate_bvalue_to_parseable_classicalb; important for parsertests with labels
4777		!,
4778		"/*@label ".
4779		pp_start_label_pragma --> "/* @". % shorter version, for viewing in UI
4780		pp_end_label_pragma --> " */ ".
4781
4782		ppatoms([]) --> !, [].
4783		ppatoms([ID|T]) --> !,ppatom(ID), " ", ppatoms(T).
4784		ppatoms(X) --> {add_error(ppatoms,'Not a list of atoms: ',ppatoms(X))}.
4785
4786		ppatoms_opt_latex([]) --> !, [].
4787		ppatoms_opt_latex([ID]) --> !,pp_atom_opt_latex(ID).
4788		ppatoms_opt_latex([ID|T]) --> !,pp_atom_opt_latex(ID), " ", ppatoms_opt_latex(T).
4789		ppatoms_opt_latex(X) --> {add_error(ppatoms_opt_latex,'Not a list of atoms: ',ppatoms_opt_latex(X))}.
4790
4791		%:- use_module(bsyntaxtree,[is_set_type/2]).
4792		:- load_files(library(system), [when(compile_time), imports([environ/2])]).
4793		pp_expr1(Expr,_,_,Prio,_) --> {var(Expr)},!,"_",{Prio=500}.
4794		pp_expr1(event_b_comprehension_set(Ids,E,P),Type,_Info,Prio,LimitReached) -->
4795		{b_ast_cleanup:rewrite_event_b_comprehension_set(Ids,E,P,Type, NewExpression)},!,
4796		pp_expr(NewExpression,Prio,LimitReached).
4797		pp_expr1(union(b(event_b_identity,Type,_), b(closure(Rel),Type,_)),_,Info,500,LimitReached) -->
4798		/* closure(Rel) = id \/ closure1(Rel) */
4799	?	{member_in_info(was(reflexive_closure),Info)},!,
4800		"closure(",pp_expr(Rel,_,LimitReached),")".
4801		pp_expr1(comprehension_set([_],_),_,Info,500,_LimitReached) -->
4802		{memberchk_in_info(freetype(P),Info),!},ppatom(P).
4803		% used instead of constants(Expr,Symbol) case below:
4804		pp_expr1(greater_equal(A,Y),Type,Info,Prio,LimitReached) --> % x:NATURAL was rewritten to x>=0, see test 499, 498
4805		{memberchk_in_info(was(member(A,B)),Info), get_integer(Y,_)},
4806		pp_expr1(member(A,B),Type,Info,Prio,LimitReached).
4807		pp_expr1(comprehension_set([TID],b(B,_,_)),Type,Info,Prio,LimitReached) -->
4808		{memberchk_in_info(was(integer_set(S)),Info)},
4809		{S='INTEGER' -> B=truth
4810		; get_texpr_id(TID,ID),
4811		B=greater_equal(TID2,Y), get_integer(Y,I),
4812		get_texpr_id(TID2,ID),
4813		(I=0 -> S='NATURAL' ; I=1,S='NATURAL1')}, % TO DO: check bounds
4814		!,
4815		pp_expr1(integer_set(S),Type,Info,Prio,LimitReached).
4816		pp_expr1(interval(b(A,_,_),B),Type,Info,Prio,LimitReached) -->
4817		{memberchk_in_info(was(integer_set(S)),Info)},
4818		{B=b(max_int,integer,_)}, % TO DO ? allow value(int(Mx))
4819		{A=min_int -> S='INT' ; A=integer(0) -> S='NAT' ; A=integer(1),S='NAT1'},
4820		!,
4821		pp_expr1(integer_set(S),Type,Info,Prio,LimitReached).
4822		pp_expr1(falsity,_,Info,Prio,LimitReached) --> {memberchk_in_info(was(Pred),Info)},!,
4823		({(unicode_mode ; latex_mode)}
4824		-> {translate_in_mode(falsity,'falsity',Symbol)},
4825		ppatom(Symbol),
4826		({get_preference(pp_propositional_logic_mode,true)} -> {true}
4827		; " ", enter_comment, " ", pp_expr2(Pred,Prio,LimitReached), " ", exit_comment)
4828		; enter_comment, " falsity ",exit_comment, " ",
4829		pp_expr2(Pred,Prio,LimitReached)). % Pred is not wrapped
4830		pp_expr1(truth,_,Info,Prio,LimitReached) --> {memberchk_in_info(was(Pred),Info)},!,
4831		({(unicode_mode ; latex_mode)}
4832		-> {translate_in_mode(truth,'truth',Symbol)},
4833		ppatom(Symbol),
4834		({get_preference(pp_propositional_logic_mode,true)} -> {true}
4835		; " ",enter_comment, " ", pp_expr2(Pred,Prio,LimitReached), " ", exit_comment)
4836		; enter_comment, " truth ", exit_comment, " ",
4837		pp_expr2(Pred,Prio,LimitReached)). % Pred is not wrapped
4838		% TO DO: do this for other expressions as well; but then we have to ensure that ast_cleanup generates complete was(_) infos
4839		% :- load_files(library(system), [when(compile_time), imports([environ/2])]). % directive moved above to avoid Spider warning
4840		pp_expr1(event_b_identity,Type,_Info,500,_LimitReached) -->
4841		{\+ eventb_translation_mode}, %{atelierb_mode(prover(_)},
4842		{is_set_type(Type,couple(ElType,ElType))},
4843		!,
4844		"id(", {pretty_normalized_type(ElType,S)},ppatom(S), ")".
4845		pp_expr1(typeset,SType,_Info,500,_LimitReached) --> % normally removed by ast_cleanup
4846		{is_set_type(SType,Type)},
4847		!,
4848		({normalized_type_requires_outer_paren(Type)} -> "(" ; ""),
4849		{pretty_normalized_type(Type,S)},ppatom(S),
4850		({normalized_type_requires_outer_paren(Type)} -> ")" ; "").
4851		:- if(environ(prob_safe_mode,true)).
4852		pp_expr1(exists(Parameters,_),_,Info,_Prio,_LimitReached) -->
4853		{\+ member_in_info(used_ids(_),Info),
4854		add_error(translate,'Missing used_ids Info for exists: ',Parameters:Info),fail}.
4855		%pp_expr1(exists(Ids,P1),_,Info,250) --> !, { member_in_info(used_ids(Used),Info)},
4856		% exists_symbol,pp_expr_ids_in_mode(Ids,LimitReached),
4857		% {add_normal_typing_predicates(Ids,P1,P)},
4858		% " /* Used = ", ppterm(Used), " */ ",
4859		% ".",pp_expr_m(P,221).
4860		:- endif.
4861		pp_expr1(Expr,Type,Info,Prio,LimitReached) --> {member_in_info(sharing(ID,Count,_,_),Info),number(Count),Count>1},!,
4862		"( ",enter_comment," CSE ",ppnumber(ID), ":#", ppnumber(Count),
4863		({member_in_info(negated_cse,Info)} -> " (neg) " ; " "),
4864		({member_in_info(contains_wd_condition,Info)} -> " (wd) " ; " "),
4865		exit_comment, " ",
4866		{delete(Info,sharing(_,_,_,_),Info2)},
4867		pp_expr1(Expr,Type,Info2,Prio,LimitReached), ")".
4868		%pp_expr1(Expr,_,Info,Prio) --> {member_in_info(contains_wd_condition,Info)},!,
4869		% "( /* (wd) */ ", pp_expr2(Expr,Prio), ")".
4870		% pp_expr1(Expr,subst,_Info,Prio) --> !, translate_subst2(Expr,Prio). % TO DO: also allow substitutions here
4871		pp_expr1(value(V),Type,_,Prio,LimitReached) --> !,
4872		{(nonvar(V),V=closure(_,_,_) -> Prio=300 ; Prio=500)}, pp_value_with_type(V,Type,LimitReached).
4873		pp_expr1(comprehension_set(Ids,P1),_,Info,500,LimitReached) --> !,
4874		pp_comprehension_set(Ids,P1,Info,LimitReached).
4875		%pp_expr1(Expr,_,Info,Prio,LimitReached) --> {pp_is_important_info_field(Expr,Info,_)},
4876		% !, pp_important_infos(Expr,Info), pp_expr2(Expr,Prio,LimitReached).
4877		pp_expr1(first_of_pair(X),_,Info,500,LimitReached) --> {was_eventb_destructor(Info,X,Op,Arg)},!,
4878		ppatom(Op), "(",pp_expr(Arg,_,LimitReached), ")".
4879		pp_expr1(second_of_pair(X),_,Info,500,LimitReached) --> {was_eventb_destructor(Info,X,Op,Arg)},!,
4880		ppatom(Op), "(",pp_expr(Arg,_,LimitReached), ")".
4881		%pp_expr1(let_expression(_Ids,Exprs,_P),_Type,Info,500,LimitReached) -->
4882		% % pretty print direct definition operator calls, which get translated using create_z_let
4883		% % However: the lets can get removed; in which case the translated direct definition will be pretty printed
4884		% % also: what if the body of the let has been modified ??
4885		% {member(was(extended_expr(DirectDefOp)),Info),
4886		% bmachine_eventb:stored_operator_direct_definition(DirectDefOp,_Proj,_Theory,Parameters,_Def,_WD,_TypeParas,_Kind),
4887		% %length(Exprs,Arity),,length(Parameters,Arity1), write(found_dd(DirectDefOp,Arity1,Arity2,Proj,Theory)),nl,
4888		% same_length(Parameters,ActualParas), %same_length(TypeParameters,TP),
4889		% append(ActualParas,_TP,Exprs)
4890		% },
4891		% !,
4892		% ppatom(DirectDefOp),
4893		% pp_expr_wrap_l('(',ActualParas,')',LimitReached).
4894		pp_expr1(Expr,_,_Info,Prio,LimitReached) --> pp_expr2(Expr,Prio,LimitReached).
4895
4896		was_eventb_destructor(Info,X,Op,Arg) :- eventb_translation_mode,
4897		member(was(extended_expr(Op)),Info),peel_projections(X,Arg).
4898		is_projection(first_of_pair(A),A).
4899		is_projection(second_of_pair(A),A).
4900		% peel projections constructed for Event-B destructor operator
4901		peel_projections(b(A,_,_),R) :-
4902		(is_projection(A,RA) -> peel_projections(RA,R)
4903		; A = freetype_destructor(_,_,R)).
4904
4905
4906		:- public pp_important_infos/4. % debugging utility
4907		pp_important_infos(Expr,Info) -->
4908		{findall(PPI,pp_is_important_info_field(Expr,Info,PPI),PPInfos), PPInfos \= []},
4909		" ", enter_comment, ppterm(PPInfos), exit_comment, " ".
4910		pp_is_important_info_field(_,Infos,'DO_NOT_ENUMERATE'(X)) :- member(prob_annotation('DO_NOT_ENUMERATE'(X)),Infos).
4911		pp_is_important_info_field(exists(_,_),Infos,'LIFT') :- member(allow_to_lift_exists,Infos).
4912		pp_is_important_info_field(exists(_,_),Infos,used_ids(Used)) :- member(used_ids(Used),Infos).
4913		pp_is_important_info_field(exists(_,_),Infos,'(wd)') :- member(contains_wd_condition,Infos).
4914
4915
4916		pp_expr2(Expr,_,_LimitReached) --> {var(Expr)},!,"_".
4917		pp_expr2(_,_,LimitReached) --> {LimitReached==limit_reached},!,"...".
4918		pp_expr2(atom_string(V),500,_) --> !,pp_atom_opt_latex_mathit(V). % hardwired_atom
4919		pp_expr2(global_set(V),500,_) --> !, pp_identifier(V).
4920		pp_expr2(freetype_set(V),500,_) --> !,{pretty_freetype(V,P)},ppatom_opt_scramble(P).
4921		pp_expr2(lazy_lookup_expr(I),500,_) --> !, pp_identifier(I).
4922		pp_expr2(lazy_lookup_pred(I),500,_) --> !, pp_identifier(I).
4923		pp_expr2(identifier(I),500,_) --> !,
4924		{( I=op(Id) -> true; I=Id)},
4925		( {atomic(Id)} -> ({translated_identifier(Id,TId)},
4926		({latex_mode} -> ppatom(TId) ; pp_identifier(TId)))
4927		;
4928		"'",ppterm(Id), "'").
4929		pp_expr2(integer(N),500,_) --> !, ppnumber(N).
4930		pp_expr2(real(N),500,_) --> !, ppatom(N).
4931		pp_expr2(integer_set(S),500,_) --> !,
4932		{integer_set_mapping(S,T)},ppatom(T).
4933		pp_expr2(string(S),500,_) --> !, string_start_symbol, ppstring_opt_scramble(S), string_end_symbol.
4934		pp_expr2(set_extension(Ext),500,LimitReached) --> !, {set_brackets(L,R)},
4935		pp_expr_wrap_l(L,Ext,R,LimitReached).
4936		pp_expr2(sequence_extension(Ext),500,LimitReached) --> !,
4937		pp_begin_sequence,
4938		({get_preference(translate_print_cs_style_sequences,true)} -> pp_expr_l_sep(Ext,"",LimitReached)
4939		; pp_expr_l_sep(Ext,",",LimitReached)),
4940		pp_end_sequence.
4941		pp_expr2(assign(LHS,RHS),10,LimitReached) --> !,
4942		pp_expr_wrap_l(',',LHS,'',LimitReached), ":=", pp_expr_wrap_l(',',RHS,'',LimitReached).
4943		pp_expr2(assign_single_id(LHS,RHS),10,LimitReached) --> !, pp_expr2(assign([LHS],[RHS]),10,LimitReached).
4944		pp_expr2(parallel(RHS),10,LimitReached) --> !,
4945		pp_expr_wrap_l('||',RHS,'',LimitReached).
4946		pp_expr2(sequence(RHS),10,LimitReached) --> !,
4947		pp_expr_wrap_l(';',RHS,'',LimitReached).
4948		pp_expr2(event_b_comprehension_set(Ids,E,P1),500,LimitReached) --> !, % normally conversion above should trigger; this is if we call pp_expr for untyped expressions
4949		pp_event_b_comprehension_set(Ids,E,P1,LimitReached).
4950		pp_expr2(recursive_let(Id,S),500,LimitReached) --> !,
4951		({eventb_translation_mode} -> "" % otherwise we get strange characters in Rodin
4952		; enter_comment," recursive ID ", pp_expr(Id,_,LimitReached), " ", exit_comment),
4953		pp_expr(S,_,LimitReached).
4954		pp_expr2(image(A,B),300,LimitReached) --> !,
4955		pp_expr_m(A,249,LimitReached),"[", % was 0; but we may have to bracket A; e.g., f <| {2} [{2}] is not ok; 250 is priority of lambda
4956		pp_expr_m(B,0,LimitReached),"]". % was 500, now set to 0: we never need an outer pair of () !?
4957		pp_expr2(function(A,B),300,LimitReached) --> !,
4958		pp_expr_m(A,249,LimitReached), % was 0; but we may have to bracket A; e.g., f <| {2} (2) is not ok; 250 is priority of lambda
4959		pp_function_left_bracket,
4960		pp_expr_m(B,0,LimitReached), % was 500, now set to 0: we never need an outer pair of () !?
4961		pp_function_right_bracket.
4962		pp_expr2(definition(A,B),300,LimitReached) --> !, % definition call; usually inlined,...
4963		ppatom(A),
4964		pp_function_left_bracket,
4965		pp_expr_l_sep(B,",",LimitReached),
4966		pp_function_right_bracket.
4967		pp_expr2(operation_call_in_expr(A,B),300,LimitReached) --> !,
4968		pp_expr_m(A,249,LimitReached),
4969		pp_function_left_bracket,
4970		pp_expr_l_sep(B,",",LimitReached),
4971		pp_function_right_bracket.
4972		pp_expr2(enumerated_set_def(GS,ListEls),200,LimitReached) --> !, % for pretty printing enumerate set defs
4973		{reverse(ListEls,RLE)}, /* they have been inserted in inverse order */
4974		pp_identifier(GS), "=", pp_expr_wrap_l('{',RLE,'}',LimitReached).
4975		pp_expr2(forall(Ids,D1,P),Prio,LimitReached) --> !,
4976		({eventb_translation_mode} -> {Prio=60} ; {Prio=250}), % in Rodin forall/exists cannot be mixed with &, or, <=>, ...
4977		forall_symbol,pp_expr_ids_in_mode(Ids,LimitReached),
4978		{add_normal_typing_predicates(Ids,D1,D)},
4979		dot_symbol,pp_expr_m(b(implication(D,P),pred,[]),221,LimitReached).
4980		pp_expr2(exists(Ids,P1),Prio,LimitReached) --> !,
4981		({eventb_translation_mode} -> {Prio=60} ; {Prio=250}), % exists has Prio 250, but dot has 220
4982		exists_symbol,pp_expr_ids_in_mode(Ids,LimitReached),
4983		{add_normal_typing_predicates(Ids,P1,P)},
4984		dot_symbol,
4985		({eventb_translation_mode} -> {MinPrio=29} ; {MinPrio=500}),
4986		% used to be 221, but #x.x>7 or #x.not(...) are not parsed by Atelier-B or ProB, x.x and x.not are parsed as composed identifiers
4987		% In Event-B ∃y·y>x ∧ (y=x+1 ∨ y=x+2) is valid and requires no outer parenthesis
4988		pp_expr_m(P,MinPrio,LimitReached).
4989		pp_expr2(record_field(R,I),250,LimitReached) --> !,
4990		pp_expr_m(R,251,LimitReached),"'",pp_identifier(I).
4991		pp_expr2(rec(Fields),500,LimitReached) --> !,
4992		{function_like_in_mode(rec,Symbol)},
4993		ppatom(Symbol), "(",pp_expr_fields(Fields,LimitReached),")".
4994		pp_expr2(struct(Rec),500,LimitReached) -->
4995		{get_texpr_expr(Rec,rec(Fields)),Val=false ; get_texpr_expr(Rec,value(rec(Fields)))},!,
4996		{function_like_in_mode(struct,Symbol)},
4997		ppatom(Symbol), "(",
4998		({Val==false} -> pp_expr_fields(Fields,LimitReached)
4999		; pp_value_l(Fields,',',LimitReached)),
5000		")".
5001		pp_expr2(freetype_case(_FT,L,Expr),Prio,LimitReached) --> !,
5002		%{Prio=500}, pp_freetype_term('__is_ft_case',FT,L,Expr,LimitReached).
5003		% we now pretty-print it as Expr : ran(L) assuming there is a constant L generated for every case
5004		{FTCons = b(identifier(L),any,[]), RanFTCons = b(range(FTCons),any,[])},
5005		pp_expr(b(member(Expr,RanFTCons),pred,[]),Prio,LimitReached).
5006		pp_expr2(freetype_constructor(_FT,Case,Expr),Prio,LimitReached) --> !,
5007		{FTCons = b(identifier(Case),any,[])},
5008		pp_expr(b(function(FTCons,Expr),any,[]),Prio,LimitReached).
5009		% ppatom_opt_scramble(Case),ppatom('('),pp_expr(Expr,_,LimitReached),ppatom(')').
5010		pp_expr2(freetype_destructor(_FT,Case,Expr),Prio,LimitReached) --> !,
5011		% pretty print it as: Case~(Expr)
5012		{FTCons = b(identifier(Case),any,[]), Destr = b(reverse(FTCons),any,[])},
5013		pp_expr(b(function(Destr,Expr),any,[]),Prio,LimitReached).
5014		% ({unicode_mode}
5015		% -> {unicode_translation(reverse,PowMinus1Symbol)},
5016		% ppatom(Case),ppatom(PowMinus1Symbol), % Note: we do not print the freetype's name FT
5017		% "(",pp_expr_m(Expr,0,LimitReached),")"
5018		% ; pp_freetype_term('__ft~',FT,Case,Expr,LimitReached) % TODO: maybe find better print
5019		% ).
5020		pp_expr2(let_predicate(Ids,Exprs,P),1,LimitReached) --> !,
5021		pp_expr_let_exists(Ids,Exprs,P,LimitReached). % instead of pp_expr_let
5022		pp_expr2(let_expression(Ids,Exprs,P),1,LimitReached) --> !,
5023		pp_expr_let(Ids,Exprs,P,LimitReached).
5024		pp_expr2(let_expression_global(Ids,Exprs,P),1,LimitReached) --> !, " /", "* global *", "/ ",
5025		pp_expr_let(Ids,Exprs,P,LimitReached).
5026		pp_expr2(lazy_let_pred(Id,Expr,P),Pr,LimitReached) --> !, pp_expr2(lazy_let_expr(Id,Expr,P),Pr,LimitReached).
5027		pp_expr2(lazy_let_subst(Id,Expr,P),Pr,LimitReached) --> !, pp_expr2(lazy_let_expr(Id,Expr,P),Pr,LimitReached).
5028		pp_expr2(lazy_let_expr(Id,Expr,P),1,LimitReached) --> !,
5029		pp_expr_let([Id],[Expr],P,LimitReached).
5030		pp_expr2(norm_conjunct(Cond,[]),1,LimitReached) --> !, % norm_conjunct: flattened version generated by b_interpreter_check,...
5031		"( ",pp_expr(Cond,_,LimitReached), ")".
5032		pp_expr2(norm_conjunct(Cond,[H|T]),1,LimitReached) --> !,
5033		"( ",pp_expr(Cond,_,LimitReached), ") ", and_symbol, " (", pp_expr2(norm_conjunct(H,T),_,LimitReached), ")".
5034		pp_expr2(assertion_expression(Cond,Msg,Expr),1,LimitReached) --> !,
5035		" ASSERT_EXPR (",
5036		pp_expr_m(b(convert_bool(Cond),pred,[]),30,LimitReached), ",",
5037		pp_expr_m(string(Msg),30,LimitReached), ",",
5038		pp_expr_m(Expr,30,LimitReached),
5039		" )".
5040		%pp_expr2(assertion_expression(Cond,_Msg,Expr),1) --> !,
5041		% "__ASSERT ",pp_expr_m(Cond,30),
5042		% " IN ", pp_expr_m(Expr,30).
5043		pp_expr2(partition(S,Elems),500,LimitReached) -->
5044		{eventb_translation_mode ;
5045		\+ atelierb_mode(_), length(Elems,Len), Len>50 % we need to print a quadratic number of disjoints
5046		},!,
5047		"partition(",pp_expr(S,_,LimitReached),
5048		({Elems=[]} -> ")" ; pp_expr_wrap_l(',',Elems,')',LimitReached)).
5049		pp_expr2(partition(S,Elems),500,LimitReached) --> !,
5050		"(",pp_expr(S,_,LimitReached), " = ",
5051		({Elems=[]} -> "{})"
5052		; pp_expr_l_sep(Elems,"\\/",LimitReached), pp_all_disjoint(Elems,LimitReached),")").
5053		pp_expr2(finite(S),Prio,LimitReached) --> {\+ eventb_translation_mode}, %{atelierb_mode(_)},
5054		!,
5055		pp_expr2(member(S,b(fin_subset(S),set(any),[])),Prio,LimitReached).
5056		pp_expr2(if_then_else(If,Then,Else),1,LimitReached) --> {animation_minor_mode(z)},!,
5057		"\\IF ",pp_expr_m(If,30,LimitReached),
5058		" \\THEN ",pp_expr_m(Then,30,LimitReached),
5059		" \\ELSE ",pp_expr_m(Else,30,LimitReached).
5060		%pp_expr2(if_then_else(If,Then,Else),1) --> {unicode_mode},!,
5061		% "if ",pp_expr_m(If,30), " then ",pp_expr_m(Then,30), " else ",pp_expr_m(Else,30).
5062		pp_expr2(if_then_else(If,Then,Else),Prio,LimitReached) --> {atelierb_mode(_)},!,
5063		% print IF-THEN-ELSE using a translation that Atelier-B can understand:
5064		{rewrite_if_then_else_expr_to_b(if_then_else(If,Then,Else), NExpr),
5065		get_texpr_type(Then,Type),
5066		NAst = b(NExpr,Type,[])},
5067		% construct {d,x| If => x=Then & not(if) => x=Else}(TRUE)
5068		pp_expr(NAst,Prio,LimitReached).
5069		pp_expr2(if_then_else(If,Then,Else),1,LimitReached) --> !,
5070		pp_atom_opt_mathit('IF'),pp_space, % "IF ",
5071		pp_expr_m(If,30,LimitReached),
5072		pp_space, pp_atom_opt_mathit('THEN'),pp_space, %" THEN ",
5073		pp_expr_m(Then,30,LimitReached),
5074		pp_space, pp_atom_opt_mathit('ELSE'),pp_space, %" ELSE ",
5075		pp_expr_m(Else,30,LimitReached),
5076		pp_space, pp_atom_opt_mathit('END'). %" END"
5077		pp_expr2(kodkod(Id,Identifiers),300,LimitReached) --> !,
5078		"KODKOD_CALL(",ppnumber(Id),": ",pp_expr_ids(Identifiers,LimitReached),")".
5079		pp_expr2(Expr,500,_) -->
5080		{constants_in_mode(Expr,Symbol)},!,ppatom(Symbol).
5081		pp_expr2(equal(A,B),Prio,LimitReached) -->
5082		{get_preference(pp_propositional_logic_mode,true), % a mode for printing propositional logic formuli
5083		is_boolean_value(B,BV),
5084		get_texpr_id(A,_)},!,
5085		({BV=pred_true} -> pp_expr(A,Prio,LimitReached)
5086		; pp_expr2(negation(b(equal(A,b(boolean_true,boolean,[])),pred,[])),Prio,LimitReached)).
5087		pp_expr2(Expr,Prio,LimitReached) -->
5088		{functor(Expr,F,1),
5089		unary_prefix(F,Symbol,Prio),!,
5090		arg(1,Expr,Arg),APrio is Prio+1},
5091		ppatom(Symbol), " ",
5092		pp_expr_m(Arg,APrio,LimitReached).
5093		pp_expr2(Expr,500,LimitReached) -->
5094		{functor(Expr,F,1),
5095		unary_prefix_parentheses(F,Symbol),!,
5096		arg(1,Expr,Arg)},
5097		pp_atom_opt_latex(Symbol), "(", pp_expr(Arg,_,LimitReached), ")".
5098		pp_expr2(Expr,Prio,LimitReached) -->
5099		{functor(Expr,F,1),
5100		unary_postfix_in_mode(F,Symbol,Prio),!,
5101		arg(1,Expr,Arg),APrio is Prio+1},
5102		pp_expr_m(Arg,APrio,LimitReached),ppatom(Symbol).
5103		pp_expr2(power_of(Left,Right),Prio,LimitReached) --> {latex_mode},!, % special case, as we need to put {} around RHS
5104		{Prio=200, LPrio is Prio+1, RPrio = Prio},
5105		pp_expr_m(Left,LPrio,LimitReached),
5106		"^{",
5107		pp_expr_m(Right,RPrio,LimitReached),
5108		"}".
5109		pp_expr2(power_of_real(Left,Right),Prio,LimitReached) --> !,
5110		({get_texpr_expr(Right,convert_real(RI))}
5111		-> pp_expr2(power_of(Left,RI),Prio,LimitReached) % the Atelier-B power_of expects integer exponent
5112		; pp_external_call('RPOW',[Left,Right],expression,Prio,LimitReached)
5113		).
5114		pp_expr2(Expr,OPrio,LimitReached) -->
5115		{functor(Expr,F,2),
5116		binary_infix_in_mode(F,Symbol,Prio,Ass),!,
5117		arg(1,Expr,Left),
5118		arg(2,Expr,Right),
5119		( Ass = left, binary_infix_symbol(Left,Symbol) -> LPrio is Prio-1, RPrio is Prio+1
5120		; Ass = right, binary_infix_symbol(Right,Symbol) -> LPrio is Prio+1, RPrio is Prio-1
5121		; LPrio is Prio+1, RPrio is Prio+1)},
5122		% Note: Prio+1 is actually not necessary, Prio would be sufficient, as pp_expr_m uses a strict comparison <
5123		({always_surround_by_parentheses(F)} -> "(",{OPrio=1000} ; {OPrio=Prio}),
5124		pp_expr_m(Left,LPrio,LimitReached),
5125		" ", ppatom(Symbol), " ",
5126		pp_expr_m(Right,RPrio,LimitReached),
5127		({always_surround_by_parentheses(F)} -> ")" ; []).
5128		pp_expr2(first_of_pair(X),500,LimitReached) --> {get_texpr_type(X,couple(From,To))},!,
5129		"prj1(", % TO DO: Latex version
5130		({\+ atelierb_mode(_)} % eventb_translation_mode
5131		-> "" % no need to print types in Event-B or with new parser;
5132		% TODO: also with new parser no longer required; only print in Atelier-B mode
5133		; {pretty_normalized_type(From,FromT),
5134		pretty_normalized_type(To,ToT)},
5135		pp_atom_opt_latex(FromT), ",", pp_atom_opt_latex(ToT),
5136		")("
5137		),
5138		pp_expr(X,_,LimitReached),")".
5139		pp_expr2(second_of_pair(X),500,LimitReached) --> {get_texpr_type(X,couple(From,To))},!,
5140		"prj2(", % TO DO: Latex version
5141		({\+ atelierb_mode(_)} -> "" % no need to print types in Event-B or with new parser
5142		; {pretty_normalized_type(From,FromT),
5143		pretty_normalized_type(To,ToT)},
5144		pp_atom_opt_latex(FromT), ",", pp_atom_opt_latex(ToT),
5145		")("
5146		),
5147		pp_expr(X,_,LimitReached),")".
5148		pp_expr2(Call,Prio,LimitReached) --> {external_call(Call,Kind,Symbol,Args)},!,
5149		pp_external_call(Symbol,Args,Kind,Prio,LimitReached).
5150		pp_expr2(card(A),500,LimitReached) --> {latex_mode, get_preference(latex_pp_greek_ids,true)},!,
5151		"|",pp_expr_m(A,0,LimitReached),"|".
5152		pp_expr2(Expr,500,LimitReached) -->
5153		{functor(Expr,F,_),
5154		function_like_in_mode(F,Symbol),!,
5155		Expr =.. [F|Args]},
5156		ppatom(Symbol),
5157		({Args=[]}
5158		-> "" % some operators like pred and succ do not expect arguments
5159		; pp_expr_wrap_l('(',Args,')',LimitReached)).
5160		pp_expr2(Expr,250,LimitReached) -->
5161		{functor(Expr,F,3),
5162		quantified_in_mode(F,Symbol),
5163		Expr =.. [F,Ids,P1,E],
5164		!,
5165		add_normal_typing_predicates(Ids,P1,P)},
5166		ppatom(Symbol),pp_expr_ids(Ids,LimitReached),".(",
5167		pp_expr_m(P,11,LimitReached),pp_such_that_bar(E),
5168		pp_expr_m(E,11,LimitReached),")".
5169		pp_expr2(Expr,Prio,LimitReached) -->
5170		{functor(Expr,F,N),
5171		(debug_mode(on)
5172		-> format('**** Unknown functor ~w/~w in pp_expr2~n expression: ~w~n',[F,N,Expr])
5173		; format('**** Unknown functor ~w/~w in pp_expr2~n',[F,N])
5174		),
5175		%add_internal_error('Unknown Expression: ',pp_expr2(Expr,Prio)),
5176		Prio=20},
5177		ppterm_with_limit_reached(Expr,LimitReached).
5178
5179		:- use_module(external_function_declarations,[synonym_for_external_predicate/2]).
5180
5181		pp_external_call('MEMOIZE_STORED_FUNCTION',[TID],_,500,LimitReached) -->
5182		{get_integer(TID,ID),memoization:get_registered_function_name(ID,Name)},!,
5183		pp_expr_m(atom_string(Name),20,LimitReached),
5184		" /*@memo ", pp_expr_m(TID,20,LimitReached), "*/".
5185		pp_external_call('STRING_LENGTH',[Arg],_,Prio,LimitReached) -->
5186		{get_preference(allow_sequence_operators_on_strings,true)},!,
5187		pp_expr2(size(Arg),Prio,LimitReached).
5188		pp_external_call('STRING_APPEND',[Arg1,Arg2],_,Prio,LimitReached) -->
5189		{get_preference(allow_sequence_operators_on_strings,true)},!,
5190		pp_expr2(concat(Arg1,Arg2),Prio,LimitReached).
5191		pp_external_call('STRING_CONC',[Arg1],_,Prio,LimitReached) -->
5192		{get_preference(allow_sequence_operators_on_strings,true)},!,
5193		pp_expr2(general_concat(Arg1),Prio,LimitReached).
5194		% we could also pretty-print RMUL, ...
5195		pp_external_call(PRED,Args,pred,Prio,LimitReached) -->
5196		{get_preference(translate_ids_to_parseable_format,true),
5197		synonym_for_external_predicate(PRED,FUNC)},
5198		!, % print external predicate as function, as parser can only parse the latter without access to DEFINITIONS
5199		pp_expr2(equal(b(external_function_call(FUNC,Args),boolean,[]),
5200		b(boolean_true,boolean,[])),Prio,LimitReached).
5201		pp_external_call(Symbol,Args,_,Prio,LimitReached) -->
5202		({invisible_external_pred(Symbol)}
5203		-> pp_expr2(truth,Prio,LimitReached),
5204		" /* ",pp_expr_m(atom_string(Symbol),20,LimitReached),pp_expr_wrap_l('(',Args,') */',LimitReached)
5205		; {Prio=500},pp_expr_m(atom_string(Symbol),20,LimitReached),
5206		pp_expr_wrap_l('(',Args,')',LimitReached) % pp_expr_wrap_l('/*EXT:*/(',Args,')')
5207		).
5208
5209		invisible_external_pred('LEQ_SYM').
5210		invisible_external_pred('LEQ_SYM_BREAK'). % just for symmetry breaking foralls,...
5211		external_call(external_function_call(Symbol,Args),expression,Symbol,Args).
5212		external_call(external_pred_call(Symbol,Args),pred,Symbol,Args).
5213		external_call(external_subst_call(Symbol,Args),subst,Symbol,Args).
5214
5215		pp_all_disjoint([H1,H2],LimitReached) --> !, " ",and_symbol," ", pp_disjoint(H1,H2,LimitReached).
5216		pp_all_disjoint([H1|T],LimitReached) --> pp_all_disjoint_aux(T,H1,LimitReached), pp_all_disjoint(T,LimitReached).
5217		pp_all_disjoint([],_) --> "".
5218
5219		pp_all_disjoint_aux([],_,_) --> "".
5220		pp_all_disjoint_aux([H2|T],H1,LimitReached) --> " ",and_symbol," ",
5221		pp_disjoint(H1,H2,LimitReached), pp_all_disjoint_aux(T,H1,LimitReached).
5222
5223		pp_disjoint(H1,H2,LimitReached) --> pp_expr(H1,_), "/\\", pp_expr(H2,_,LimitReached), " = {}".
5224
5225
5226		% given a list of predicates and an ID either extract ID:Set and return Set or return its type as string
5227		select_membership([],TID,[],atom_string(TS)) :- % atom_string used as wrapper for pp_expr2
5228		get_texpr_type(TID,Type), pretty_type(Type,TS).
5229		select_membership([Pred|Rest],TID,Rest,Set) :-
5230		Pred = b(member(TID2,Set),pred,_),
5231		same_id(TID2,TID,_),!.
5232		select_membership([Pred|Rest],TID,Rest,Set) :-
5233		Pred = b(equal(TID2,EqValue),pred,_),
5234		same_id(TID2,TID,_),!, get_texpr_type(TID,Type),
5235		Set = b(set_extension([EqValue]),set(Type),[]).
5236		select_membership([Pred|T],TID,[Pred|Rest],Set) :-
5237		select_membership(T,TID,Rest,Set).
5238
5239		% pretty print prj1/prj2
5240		pp_prj12(Prj,Set1,Set2,LimitReached) -->
5241		ppatom(Prj),"(",pp_expr(Set1,_,LimitReached),",",pp_expr(Set2,_),")".
5242
5243		%:- use_module(bsyntaxtree,[is_a_disjunct/3, get_integer/2]).
5244
5245		pp_comprehension_set(Ids,P1,Info,LimitReached) -->
5246		pp_comprehension_set5(Ids,P1,Info,LimitReached,_).
5247
5248		% the extra argument of pp_comprehension_set5 indicates whether a special(Rule) was applied or not
5249		%pp_comprehension_set(IDs,Body,Info,LimitReached,_) --> {print(pp(IDs,Body,Info)),nl,fail}.
5250		pp_comprehension_set5([TID1,TID2,TID3],Body,_Info,LimitReached,special(Proj)) -->
5251		/* This comprehension set was a projection function (prj1/prj2) */
5252		% %(z_,z__).(z__ : NATURAL|z_) -> prj1(INTEGER,NATURAL)
5253		{get_texpr_id(TID1,ID1), % sometimes _zzzz_unary or _prj_arg1__
5254		get_texpr_id(TID2,ID2), % sometimes _zzzz_binary or _prj_arg2__
5255		get_texpr_id(TID3,LambdaID),
5256	?	get_lambda_equality(Body,LambdaID,RestBody,ResultExpr),
5257		get_texpr_id(ResultExpr,ResultID),
5258		(ResultID = ID1 -> Proj = prj1 ; ResultID = ID2, Proj = prj2),
5259		flatten_conjunctions(RestBody,Rest1),
5260		select_membership(Rest1,TID1,Rest2,Set1),
5261		select_membership(Rest2,TID2,[],Set2)},
5262		!,
5263		pp_prj12(Proj,Set1,Set2,LimitReached).
5264		pp_comprehension_set5([ID1|T],Body,Info,LimitReached,special(disjunct)) --> {is_a_disjunct(Body,B1,B2),
5265		get_last(T,ID1,_FrontIDs,LastID),
5266		is_lambda_result_id(LastID,_Suffix)},!, % we seem to have the union of two lambda expressions
5267		"(", pp_comprehension_set([ID1|T],B1,Info,LimitReached),
5268		" \\/ ", pp_comprehension_set([ID1|T],B2,Info,LimitReached), ")".
5269		pp_comprehension_set5([b(identifier('_pred_'),integer,_),
5270		b(identifier(LAMBDARES),integer,_)],Body,_,_,special(pred)) --> % '_lambda_result_'
5271		{Body = b(equal(LR,T),pred,_),
5272		LR = b(identifier(LAMBDARES),integer,_),
5273		T = b(minus(ARG,One),integer,_),
5274		get_integer(One,1),
5275		ARG = b(identifier('_pred_'),integer,_)},
5276		!,
5277		"pred".
5278		pp_comprehension_set5([b(identifier('_succ_'),integer,_),
5279		b(identifier(LAMBDARES),integer,_)],Body,_,_,special(succ)) --> % '_lambda_result_'
5280		{Body = b(equal(LR,T),pred,_),
5281		LR = b(identifier(LAMBDARES),integer,_),
5282		T = b(add(ARG,One),integer,_),
5283		get_integer(One,1),
5284		ARG = b(identifier('_succ_'),integer,_)},
5285		!,
5286		"succ".
5287		pp_comprehension_set5(Paras,Body,Info,LimitReached,special(lambda)) -->
5288		{detect_lambda_comprehension(Paras,Body, FrontIDs,LambdaBody,ToExpr)},
5289		!,
5290		{add_normal_typing_predicates(FrontIDs,LambdaBody,TLambdaBody)},
5291		({eventb_translation_mode} -> "(" ; ""), % put brackets around the lambda in Rodin
5292		pp_annotations(Info,Body),
5293		lambda_symbol, % "%"
5294		pp_lambda_identifiers(FrontIDs,LimitReached),
5295		".",
5296		({eventb_translation_mode} -> {IPrio=30} ; {IPrio=11}, "("), % In Rodin it is not ok to write (P|E)
5297		pp_expr_m(TLambdaBody,IPrio,LimitReached), % Check 11 against prio of . and |
5298		pp_such_that_bar(ToExpr),
5299		pp_expr_m(ToExpr,IPrio,LimitReached),
5300		")".
5301		pp_comprehension_set5(TIds,Body,Info,LimitReached,special(event_b_comprehension_set)) -->
5302		% detect Event-B style set comprehensions and use bullet • or Event-B notation such as {x·x ∈ 1 ‥ 3|x * 10}
5303		% gets translated to {`__comp_result__`|∃x·(x ∈ 1 ‥ 3 ∧ `__comp_result__` = x * 10)}
5304	?	{is_eventb_comprehension_set(TIds,Body,Info,Ids,P1,EXPR), \+ atelierb_mode(_)},!, % print rewritten version for AtelierB
5305		pp_annotations(Info,P1),
5306		left_set_bracket,
5307		pp_expr_l_pair_in_mode(Ids,LimitReached),
5308		{add_normal_typing_predicates(Ids,P1,P)},
5309		dot_bullet_symbol,
5310		pp_expr_m(P,11,LimitReached),
5311		pp_such_that_bar(P),
5312		pp_expr_m(EXPR,11,LimitReached),
5313		right_set_bracket.
5314		pp_comprehension_set5(Ids,P1,_Info,LimitReached,normal) --> {atelierb_mode(prover(ml))},!,
5315		"SET(",
5316		pp_expr_l_pair_in_mode(Ids,LimitReached),
5317		").(",
5318		{add_normal_typing_predicates(Ids,P1,P)},
5319		pp_expr_m(P,11,LimitReached),
5320		")".
5321		pp_comprehension_set5(Ids,P1,Info,LimitReached,normal) -->
5322		pp_annotations(Info,P1),
5323		left_set_bracket,
5324		pp_expr_l_pair_in_mode(Ids,LimitReached),
5325		{add_normal_typing_predicates(Ids,P1,P)},
5326		pp_such_that_bar(P),
5327		pp_expr_m(P,11,LimitReached),
5328		right_set_bracket.
5329
5330
5331		detect_lambda_comprehension([ID1|T],Body, FrontIDs,LambdaBody,ToExpr) :-
5332		get_last(T,ID1,FrontIDs,LastID),
5333		FrontIDs=[_|_], % at least one identifier for the lambda
5334		is_lambda_result_id(LastID,Suffix),
5335		% nl, print(lambda(Body,T,ID1)),nl,
5336		(is_an_equality(Body,From,ToExpr) -> LambdaBody = b(truth,pred,[])
5337		; is_a_conjunct(Body,LambdaBody,Equality),
5338		is_an_equality(Equality,From,ToExpr)),
5339		is_lambda_result_id(From,Suffix).
5340
5341		pp_annotations(V,_) --> {var(V), format('Illegal variable info field in pp_annotations: ~w~n',[V])},!,
5342		"/* ILLEGAL VARIABLE INFO FIED */".
5343	?	pp_annotations(INFO,_) --> {member(prob_annotation('SYMBOLIC'),INFO)},!,
5344		"/*@symbolic*/ ".
5345	?	pp_annotations(_,b(_,_,INFO)) --> {nonvar(INFO),member(prob_annotation('SYMBOLIC'),INFO)},!,
5346		"/*@symbolic*/ ".
5347		% TO DO: maybe also print other annotations like memoize, recursive ?
5348		pp_annotations(_,_) --> "".
5349
5350		pp_event_b_comprehension_set(Ids,E,P1,LimitReached) -->
5351		left_set_bracket,pp_expr_l_pair_in_mode(Ids,LimitReached),
5352		{add_normal_typing_predicates(Ids,P1,P)},
5353		pp_such_that_bar(P),pp_expr_m(P,11,LimitReached),
5354		" . ", pp_expr_m(E,11,LimitReached),right_set_bracket.
5355
5356		pp_lambda_identifiers([H1,H2|T],LimitReached) --> {\+ eventb_translation_mode},!,
5357		"(",pp_expr_l([H1,H2|T],LimitReached),")".
5358		pp_lambda_identifiers(L,LimitReached) --> pp_expr_l_pair_in_mode(L,LimitReached).
5359
5360		pp_such_that_bar(_) --> {latex_mode},!, "\\mid ".
5361		pp_such_that_bar(b(unary_minus(_),_,_)) --> !, " | ". % otherwise AtelierB complains about illegal token |-
5362		pp_such_that_bar(b(unary_minus_real(_),_,_)) --> !, " | ". % otherwise AtelierB complains about illegal token |-
5363		pp_such_that_bar(_Next) --> "|".
5364		pp_such_that_bar --> {latex_mode},!, "\\mid ".
5365		pp_such_that_bar --> "|".
5366
5367		is_an_equality(b(equal(A,B),_,_),A,B).
5368
5369		integer_set_mapping(A,B) :- integer_set_mapping(A,_,B).
5370		integer_set_mapping(A,integer_set,B) :- unicode_mode, unicode_translation(A,B),!.
5371		integer_set_mapping(A,integer_set,B) :- latex_mode, latex_integer_set_translation(A,B),!.
5372		integer_set_mapping(A,integer_set,B) :- atelierb_mode(prover(PPML)),
5373		atelierb_pp_translation(A,PPML,B),!.
5374		integer_set_mapping(A,integer_set,B) :-
5375		eventb_translation_mode, eventb_integer_mapping(A,B),!.
5376		integer_set_mapping(ISet,user_set,Res) :- atomic(ISet),!,Res=ISet.
5377		integer_set_mapping(_ISet,unknown_set,'integer_set(??)').
5378
5379		eventb_integer_mapping('INTEGER','INT').
5380		eventb_integer_mapping('NATURAL','NAT').
5381		eventb_integer_mapping('NATURAL1','NAT1').
5382
5383		real_set_mapping(A,B) :- unicode_mode, unicode_translation(A,B),!.
5384		real_set_mapping(X,X). % TO DO: unicode_mode,...
5385
5386		:- dynamic comment_level/1.
5387		reset_pp :- retractall(comment_level(_)).
5388		enter_comment --> {retract(comment_level(N))},!, "(*", {N1 is N+1, assertz(comment_level(N1))}.
5389		enter_comment --> "/*", {assertz(comment_level(1))}.
5390		exit_comment --> {retract(comment_level(N))},!,
5391		({N>1} -> "*)", {N1 is N-1, assertz(comment_level(N1))} ; "*/").
5392		exit_comment --> "*/", {add_internal_error('Unmatched closing comment:',exit_comment)}.
5393		% TO DO: ensure reset_pp is called when starting to pretty print, in case timeout occurs in previous pretty prints
5394
5395		%get_last([b(identifier(_lambda_result_10),set(couple(integer,set(couple(integer,integer)))),[])],b(identifier(i),integer,[]),[b(identifier(i),integer,[])],b(identifier(_lambda_result_10),set(couple(integer,set(couple(integer,integer)))),[]))
5396
5397		get_last([],Last,[],Last).
5398		get_last([H2|T],H1,[H1|LT],Last) :- get_last(T,H2,LT,Last).
5399
5400		pp_expr_wrap_l(Pre,Expr,Post,LimitReached) -->
5401		ppatom(Pre),pp_expr_l(Expr,LimitReached),ppatom(Post).
5402		%pp_freetype_term(Term,FT,L,Expr,LimitReached) -->
5403		% {pretty_freetype(FT,P)},
5404		% ppatom(Term),"(",ppatom_opt_scramble(P),",",
5405		% ppatom(L),",",pp_expr_m(Expr,500,LimitReached),")".
5406
5407		% print a list of expressions, seperated by commas
5408		pp_expr_l_pair_in_mode(List,LimitReached) --> {eventb_translation_mode},!,
5409		{maplet_symbol(MapletStr,[])},
5410		pp_expr_l_sep(List,MapletStr,LimitReached).
5411		pp_expr_l_pair_in_mode(List,LimitReached) --> pp_expr_l_sep(List,",",LimitReached).
5412		pp_expr_l(List,LimitReached) --> pp_expr_l_sep(List,",",LimitReached).
5413
5414		pp_expr_l_sep([Expr],_,LimitReached) --> !,
5415		pp_expr_m(Expr,0,LimitReached).
5416		pp_expr_l_sep(List,Sep,LimitReached) --> pp_expr_l2(List,Sep,LimitReached).
5417		pp_expr_l2([],_Sep,_) --> !.
5418		pp_expr_l2([Expr|Rest],Sep,LimitReached) -->
5419		{get_sep_prio(Sep,Prio)},
5420		pp_expr_m(Expr,Prio,LimitReached),
5421		pp_expr_l3(Rest,Sep,LimitReached).
5422		pp_expr_l3([],_Sep,_) --> !.
5423		pp_expr_l3(Rest,Sep,LimitReached) -->
5424		Sep,pp_expr_l2(Rest,Sep,LimitReached).
5425
5426		get_sep_prio(",",Prio) :- !, Prio=116. % Prio of , is 115
5427		get_sep_prio("\\/",Prio) :- !, Prio=161.
5428		get_sep_prio("/\\",Prio) :- !, Prio=161.
5429		get_sep_prio("|->",Prio) :- !, Prio=161.
5430		get_sep_prio([8614],Prio) :- !, Prio=161.
5431		%
5432		get_sep_prio(_,161).
5433
5434		% print the fields of a record
5435		pp_expr_fields([field(Name,Expr)],LimitReached) --> !,
5436		pp_identifier(Name),":",pp_expr_m(Expr,120,LimitReached).
5437		pp_expr_fields(Fields,LimitReached) -->
5438		pp_expr_fields2(Fields,LimitReached).
5439		pp_expr_fields2([],_) --> !.
5440		pp_expr_fields2([field(Name,Expr)|Rest],LimitReached) -->
5441		pp_identifier(Name),":",
5442		pp_expr_m(Expr,116,LimitReached),
5443		pp_expr_fields3(Rest,LimitReached).
5444		pp_expr_fields3([],_) --> !.
5445		pp_expr_fields3(Rest,LimitReached) -->
5446		",",pp_expr_fields2(Rest,LimitReached).
5447
5448		% TO DO: test more fully; identifiers seem to be wrapped in brackets
5449		pp_expr_let_exists(Ids,Exprs,P,LimitReached) -->
5450		exists_symbol,
5451		({eventb_translation_mode} -> % otherwise we get strange characters in Rodin, no (.) allowed in Rodin
5452		pp_expr_ids_in_mode(Ids,LimitReached),
5453		".("
5454		; " /* LET */ (",
5455		pp_expr_l_pair_in_mode(Ids,LimitReached),
5456		").("
5457		),
5458		pp_expr_let_pred_exprs(Ids,Exprs,LimitReached),
5459		({is_truth(P)} -> ""
5460		; " ",and_symbol," ", pp_expr_m(P,40,LimitReached)),
5461		")".
5462
5463		pp_expr_let_pred_exprs([],[],_) --> !.
5464		pp_expr_let_pred_exprs([Id|Irest],[Expr|Erest],LimitReached) -->
5465		" ",pp_expr_let_id(Id,LimitReached),
5466		"=",pp_expr_m(Expr,400,LimitReached),
5467		( {Irest=[]} -> [] ; " ", and_symbol),
5468		pp_expr_let_pred_exprs(Irest,Erest,LimitReached).
5469
5470		% print a LET expression
5471		pp_expr_let(_Ids,Exprs,P,LimitReached) -->
5472		{eventb_translation_mode,
5473		P=b(_,_,I), member(was(extended_expr(Op)),I)},!, % let was created by direct_definition for a theory operator call
5474		ppatom(Op),
5475		pp_function_left_bracket,
5476		pp_expr_l_sep(Exprs,",",LimitReached),
5477		%pp_expr_let_pred_exprs(Ids,Exprs,LimitReached) % write entire predicate with parameter names
5478		pp_function_right_bracket.
5479		pp_expr_let(Ids,Exprs,P,LimitReached) -->
5480		"LET ", pp_expr_ids_no_parentheses(Ids,LimitReached),
5481		" BE ", pp_expr_let_pred_exprs(Ids,Exprs,LimitReached),
5482		" IN ",pp_expr_m(P,5,LimitReached),
5483		" END".
5484
5485		pp_expr_let_id(ID,LimitReached) --> {atomic(ID),!, print(unwrapped_let_id(ID)),nl},
5486		pp_expr_m(identifier(ID),500,LimitReached).
5487		pp_expr_let_id(ID,LimitReached) --> pp_expr_m(ID,499,LimitReached).
5488
5489		% print a list of identifiers
5490		pp_expr_ids_in_mode([],_) --> !.
5491		pp_expr_ids_in_mode(Ids,LimitReached) --> {eventb_translation_mode ; Ids=[_]},!,
5492		pp_expr_l(Ids,LimitReached). % no (.) allowed in Event-B; not necessary in B if only one id
5493		pp_expr_ids_in_mode(Ids,LimitReached) --> "(",pp_expr_l(Ids,LimitReached),")".
5494
5495		pp_expr_ids([],_) --> !.
5496		pp_expr_ids(Ids,LimitReached) -->
5497		% ( {Ids=[Id]} -> pp_expr_m(Id,221)
5498		% ;
5499		"(",pp_expr_l(Ids,LimitReached),")".
5500
5501		pp_expr_ids_no_parentheses(Ids,LimitReached) --> pp_expr_l(Ids,LimitReached).
5502
5503
5504		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5505		% pretty print types for error messages
5506
5507		%:- use_module(probsrc(typing_tools), [normalize_type/2]).
5508		% replace seq(.) types before pretty printing:
5509		pretty_normalized_type(Type,String) :- typing_tools:normalize_type(Type,NT),!,
5510		pretty_type(NT,String).
5511		pretty_normalized_type(Type,String) :-
5512		add_internal_error('Cannot normalize type:',pretty_normalized_type(Type,String)),
5513		pretty_type(Type,String).
5514
5515		% for pp_expr: do we potentially have to add parentheses
5516		normalized_type_requires_outer_paren(couple(_,_)).
5517		% all other types are either identifiers or use prefix notation (POW(.), seq(.), struct(.))
5518
5519		pretty_type(Type,String) :-
5520		pretty_type_l([Type],[String]).
5521
5522		pretty_type_l(Types,Strings) :-
5523		extract_vartype_names(Types,N),
5524		pretty_type2_l(Types,N,Strings).
5525		pretty_type2_l([],_,[]).
5526		pretty_type2_l([T|TRest],Names,[S|SRest]) :-
5527		pretty_type2(T,Names,noparen,S),
5528		pretty_type2_l(TRest,Names,SRest).
5529
5530		extract_vartype_names(Types,names(Variables,Names)) :-
5531		term_variables(Types,Variables),
5532		name_variables(Variables,1,Names).
5533
5534		pretty_type2(X,names(Vars,Names),_,Name) :- var(X),!,exact_member_lookup(X,Name,Vars,Names).
5535		pretty_type2(any,_,_,'?').
5536		pretty_type2(set(T),N,_,Text) :- nonvar(T),T=couple(A,B),!,
5537		pretty_type2(A,N,paren,AT), pretty_type2(B,N,paren,BT),
5538		binary_infix_in_mode(relations,Symbol,_,_), % <->
5539		ajoin(['(',AT,Symbol,BT,')'],Text).
5540		pretty_type2(set(T),N,_,Text) :-
5541		pretty_type2(T,N,noparen,TT), function_like_in_mode(pow_subset,POW),
5542		ajoin([POW,'(',TT,')'],Text).
5543		pretty_type2(seq(T),N,_,Text) :-
5544		pretty_type2(T,N,noparen,TT), ajoin(['seq(',TT,')'],Text).
5545		pretty_type2(couple(A,B),N,Paren,Text) :-
5546		pretty_type2(A,N,paren,AT),pretty_type2(B,N,paren,BT),
5547		binary_infix_in_mode(cartesian_product,Cart,_,_),
5548		ajoin([AT,Cart,BT],Prod),
5549		( Paren == noparen ->
5550		Text = Prod
5551		;
5552		ajoin(['(',Prod,')'],Text)).
5553		pretty_type2(string,_,_,'STRING').
5554		pretty_type2(integer,_,_,Atom) :- integer_set_mapping('INTEGER',Atom).
5555		pretty_type2(real,_,_,Atom) :- real_set_mapping('REAL',Atom).
5556		pretty_type2(boolean,_,_,'BOOL').
5557		pretty_type2(global(G_Id),_,_,A) :- opt_scramble_id(G_Id,G), ajoin([G],A).
5558		pretty_type2(freetype(Id),N,_,A) :- pretty_freetype2(Id,N,A).
5559		pretty_type2(pred,_,_,predicate).
5560		pretty_type2(subst,_,_,substitution).
5561		pretty_type2(constant(List),_,_,A) :-
5562		(var(List) -> ['{??VAR??...}'] % should not happen
5563		; ajoin_with_sep(List,',',P), ajoin(['{',P,'}'],A)).
5564		pretty_type2(record(Fields),N,_,Text) :-
5565		pretty_type_fields(Fields,N,FText),
5566		ajoin(['struct(',FText,')'],Text).
5567		pretty_type2(op(Params,Results),N,_,Text) :-
5568		pretty_type_l(Params,N,PText),
5569		( nonvar(Results),Results=[] ->
5570		ajoin(['operation(',PText,')'],Text)
5571		;
5572		pretty_type_l(Results,N,RText),
5573		ajoin([RText,'<--operation(',PText,')'],Text) ).
5574		pretty_type2(definition(DefType,_,_),_,_,DefType).
5575		pretty_type2(witness,_,_,witness).
5576		pretty_type2([],_,_,'[]') :- add_error(pretty_type,'Illegal list in type:','[]').
5577		pretty_type2([H|T],_,_,'[_]') :- add_error(pretty_type,'Illegal list in type:',[H|T]).
5578		pretty_type2(b(E,T,I),_,_,'?') :- add_error(pretty_type,'Illegal b/3 term in type:',b(E,T,I)).
5579
5580		pretty_type_l(L,_,'...') :- var(L),!.
5581		pretty_type_l([],_,'') :- !.
5582		pretty_type_l([E|Rest],N,Text) :-
5583		pretty_type2(E,N,noparen,EText),
5584		( nonvar(Rest),Rest=[] ->
5585		EText=Text
5586		;
5587		pretty_type_l(Rest,N,RText),
5588		ajoin([EText,',',RText],Text)).
5589
5590		pretty_type_fields(L,_,'...') :- var(L),!.
5591		pretty_type_fields([],_,'') :- !.
5592		pretty_type_fields([field(Name,Type)|FRest],N,Text) :- !,
5593		pretty_type2(Type,N,noparen,TText),
5594		ptf_seperator(FRest,Sep),
5595		pretty_type_fields(FRest,N,RestText),
5596		opt_scramble_id(Name,ScrName),
5597		ajoin([ScrName,':',TText,Sep,RestText],Text).
5598		pretty_type_fields(Err,N,Text) :-
5599		add_internal_error('Illegal field type: ',pretty_type_fields(Err,N,Text)), Text='??'.
5600		ptf_seperator(L,', ') :- var(L),!.
5601		ptf_seperator([],'') :- !.
5602		ptf_seperator(_,', ').
5603
5604		pretty_freetype(Id,A) :-
5605		extract_vartype_names(Id,N),
5606		pretty_freetype2(Id,N,A).
5607		pretty_freetype2(Id,_,A) :- var(Id),!,A='_'.
5608		pretty_freetype2(Id,_,A) :- atomic(Id),!,Id=A.
5609		pretty_freetype2(Id,N,A) :-
5610		Id=..[Name|TypeArgs],
5611		pretty_type2_l(TypeArgs,N,PArgs),
5612		ajoin_with_sep(PArgs,',',P),
5613		ajoin([Name,'(',P,')'],A).
5614
5615		name_variables([],_,[]).
5616		name_variables([_|VRest],Index,[Name|NRest]) :-
5617		(nth1(Index,"ABCDEFGHIJKLMNOPQRSTUVWXYZ",C) -> SName = [C] ; number_codes(Index,SName)),
5618		append("_",SName,CName),atom_codes(Name,CName),
5619		Next is Index+1,
5620		name_variables(VRest,Next,NRest).
5621
5622		ppatom(Var) --> {var(Var)},!, ppatom('$VARIABLE').
5623		ppatom(Cmp) --> {compound(Cmp)},!, ppatom('$COMPOUND_TERM').
5624		ppatom(Atom) --> {safe_atom_codes(Atom,Codes)}, ppcodes(Codes).
5625
5626		ppnumber(Number) --> {var(Number)},!,pp_clpfd_variable(Number).
5627		ppnumber(inf) --> !,"inf".
5628		ppnumber(minus_inf) --> !,"minus_inf".
5629		ppnumber(Number) --> {number(Number),number_codes(Number,Codes)},!, ppcodes(Codes).
5630		ppnumber(Number) --> {add_internal_error('Not a number: ',ppnumber(Number,_,_))}, "<<" ,ppterm(Number), ">>".
5631
5632		pp_numberedvar(N) --> "_",ppnumber(N),"_".
5633
5634		pp_clpfd_variable(X) --> "?:",{fd_dom(X,Dom)},write_to_codes(Dom), pp_frozen_info(X).
5635
5636		pp_frozen_info(_X) --> {get_preference(translate_print_frozen_infos,false)},!,[].
5637		pp_frozen_info(X) -->
5638		":(",{frozen(X,Goal)},
5639		write_goal_with_max_depth(Goal),
5640		")".
5641
5642		write_goal_with_max_depth((A,B)) --> !, "(",write_goal_with_max_depth(A),
5643		", ", write_goal_with_max_depth(B), ")".
5644		write_goal_with_max_depth(Term) --> write_with_max_depth(3,Term).
5645
5646		write_with_max_depth(Depth,Term,S1,S2) :- write_term_to_codes(Term,S1,S2,[max_depth(Depth)]).
5647
5648		ppterm(Term) --> write_to_codes(Term).
5649
5650		ppcodes([],S,S).
5651		ppcodes([C|Rest],[C|In],Out) :- ppcodes(Rest,In,Out).
5652
5653		ppterm_with_limit_reached(Term,LimitReached) -->
5654		{write_to_codes(Term,Codes,[])}, ppcodes_with_limit_reached(Codes,LimitReached).
5655
5656		ppcodes_with_limit_reached([C|Rest],LimitReached,[C|In],Out) :- var(LimitReached), !,
5657		ppcodes_with_limit_reached(Rest,LimitReached,In,Out).
5658		ppcodes_with_limit_reached(_,_LimitReached,S,S).
5659
5660		% for debugging:
5661		:- public b_portray_hook/1.
5662		b_portray_hook(X) :-
5663		nonvar(X),
5664		(is_texpr(X), ground(X) -> write('{# '),print_bexpr_or_subst(X),write(' #}')
5665		; X=avl_set(_), ground(X) -> write('{#avl '), print_bvalue(X), write(')}')
5666		; X=wfx(WF0,_,WFE,Info) -> format('wfx(~w,$mutable,~w,~w)',[WF0,WFE,Info]) % to do: short summary of prios & call stack
5667		).
5668
5669		install_b_portray_hook :- % register portray hook mainly for the Prolog debugger
5670		assertz(( user:portray(X) :- translate:b_portray_hook(X) )).
5671		remove_b_portray_hook :-
5672		retractall( user:portray(_) ).
5673
5674
5675		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5676		% Pretty-print of Event-B models as classical B
5677
5678		translate_eventb_to_classicalb(EBMachine,AddInfo,Rep) :-
5679		( conversion_check(EBMachine) ->
5680		convert_eventb_classicalb(EBMachine,CBMachine),
5681		call_cleanup(( set_animation_mode(b), % clear minor mode "eventb"
5682		translate_machine(CBMachine,Rep,AddInfo),!),
5683		set_animation_minor_mode(eventb))
5684		; \+ animation_minor_mode(eventb) -> add_error(translate,'Conversion only applicable to Event-B models')
5685		;
5686		add_error_and_fail(translate,'Conversion not applicable, check if you limited the number of abstract level to 0')
5687		).
5688
5689		convert_eventb_classicalb(EBMachine,CBMachine) :-
5690		select_section(operation_bodies,In,Out,EBMachine,CBMachine1),
5691		maplist(convert_eventop,In,Out),
5692		select_section(initialisation,IIn,IOut,CBMachine1,CBMachine),
5693		convert_event(IIn,[],IOut).
5694		convert_eventop(EBOp,CBOp) :-
5695		get_texpr_expr(EBOp,operation(Id,[],Args,EBBody)),
5696		get_texpr_info(EBOp,Info),
5697		convert_event(EBBody,Args,CBBody),
5698		% Remove the arguments
5699		create_texpr(operation(Id,[],[],CBBody),op([],[]),Info,CBOp).
5700		convert_event(TEvent,Parameters,TSubstitution) :-
5701		get_texpr_expr(TEvent,rlevent(_Id,_Section,_Status,_Parameters,Guard,_Theorems,Actions,_VariableWitnesses,_ParameterWitnesses,_Ums,_Refined)),
5702		in_parallel(Actions,PAction),
5703		convert_event2(Parameters,Guard,PAction,TSubstitution).
5704		convert_event2([],Guard,Action,Action) :-
5705		is_truth(Guard),!.
5706		convert_event2([],Guard,Action,Select) :-
5707		!,create_texpr(select([When]),subst,[],Select),
5708		create_texpr(select_when(Guard,Action),subst,[],When).
5709		convert_event2(Parameters,Guard,Action,Any) :-
5710		create_texpr(any(Parameters,Guard,Action),subst,[],Any).
5711		in_parallel([],Skip) :- !,create_texpr(skip,subst,[],Skip).
5712		in_parallel([A],A) :- !.
5713		in_parallel(Actions,Parallel) :- create_texpr(parallel(Actions),subst,[],Parallel).
5714
5715		conversion_check(Machine) :-
5716		animation_mode(b),
5717		animation_minor_mode(eventb),
5718		get_section(initialisation,Machine,Init),
5719		get_texpr_expr(Init,rlevent(_Id,_Sec,_St,_Par,_Grd,_Thms,_Act,_VW,_PW,_Ums,[])).
5720
5721		% ------------------------------------------------------------
5722
5723		% divide a B typed expression into columns for CSV export or Table viewing of its values
5724		get_bexpression_column_template(b(couple(A,B),_,_),(AVal,BVal),ColHeaders,Columns) :- !,
5725		get_bexpression_column_template(A,AVal,AHeaders,AColumns),
5726		get_bexpression_column_template(B,BVal,BHeaders,BColumns),
5727		append(AHeaders,BHeaders,ColHeaders),
5728		append(AColumns,BColumns,Columns).
5729		get_bexpression_column_template(TypedExpr,Value,[ColHeader],[Value]) :-
5730		translate:translate_bexpression_with_limit(TypedExpr,100,ColHeader).
5731
5732
5733		% a version of member that creates an error when info list not instantiated
5734		member_in_info(X,T) :- var(T),!, add_internal_error('Illegal info field:', member_in_info(X,T)),fail.
5735		member_in_info(X,[X|_]).
5736		member_in_info(X,[_|T]) :- member_in_info(X,T).
5737
5738		memberchk_in_info(X,T) :- var(T),!, add_internal_error('Illegal info field:', memberchk_in_info(X,T)),fail.
5739		memberchk_in_info(X,[X|_]) :- !.
5740		memberchk_in_info(X,[_|T]) :- memberchk_in_info(X,T).
5741
5742		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5743
5744		:- use_module(library(clpfd)).
5745
5746		% print also partially instantiated variables with CLP(FD) Info
5747		print_value_variable(X) :- var(X), !, print(X).
5748		print_value_variable(int(X)) :- print('int('), print_clpfd_variable(X), print(')').
5749		print_value_variable(fd(X,T)) :- print('fd('), print_clpfd_variable(X), print(','), print(T),print(')').
5750		print_value_variable(X) :- print(X).
5751
5752		print_clpfd_variable(X) :- var(X),!,print(X), print(':'), fd_dom(X,Dom), print(Dom), print_frozen_info(X).
5753		print_clpfd_variable(X) :- print(X).
5754
5755		%print_clpfd_variables([]).
5756		%print_clpfd_variables([H|T]) :- print('CLPFD: '),print_clpfd_variable(H), nl, print_clpfd_variables(T).
5757
5758
5759		:- public l_print_frozen_info/1.
5760		l_print_frozen_info([]).
5761		l_print_frozen_info([H|T]) :- print(H), print(' '),
5762		(var(H) -> print_frozen_info(H) ;
5763		H=fd_var(V,_) -> print_frozen_info(V) ; true), l_print_frozen_info(T).
5764
5765		print_frozen_info(X) :- frozen(X,Goal), print_frozen_goal(Goal).
5766		print_frozen_goal((A,B)) :- !, print_frozen_goal(A), print(','), print_frozen_goal(B).
5767		print_frozen_goal(prolog:trig_nondif(_A,_B,R,_S)) :- !, frozen(R,G2), print_frozen_goal2(G2).
5768		print_frozen_goal(G) :- print_frozen_goal2(G).
5769		print_frozen_goal2(V) :- var(V),!, print(V).
5770		print_frozen_goal2(true) :- !.
5771		print_frozen_goal2((A,B)) :- !, print_frozen_goal2(A), print(','), print_frozen_goal2(B).
5772		print_frozen_goal2(G) :- print(' :: '), tools_printing:print_term_summary(G).
5773
5774
5775		/* Event-B operators */
5776		translate_eventb_operators([]) --> !.
5777		translate_eventb_operators([Name-Call|Rest]) -->
5778		translate_eventb_operator(Call,Name),
5779		translate_eventb_operators(Rest).
5780
5781		translate_eventb_operator(Module:Call,Name) -->
5782		insertcodes("\n "),
5783		indention_codes(In,Out),
5784		{Call =.. [Functor|Args],
5785		translate_eventb_operator2(Functor,Args,Module,Call,Name,In,Out)}.
5786
5787
5788		translate_eventb_operator2(direct_definition,[Args,_RawWD,RawBody,TypeParas|_],_Module,_Call,Name) -->
5789		pp_eventb_direct_definition_header(Name,Args),!,
5790		ppcodes(" direct_definition ["),
5791		pp_eventb_operator_args(TypeParas),
5792		ppcodes("] "),
5793		{translate_in_mode(eqeq,'==',EqEqStr)}, ppatom(EqEqStr),
5794		ppcodes(" "),
5795		pp_raw_formula(RawBody). % TO DO: use indentation
5796		translate_eventb_operator2(axiomatic_definition,[Tag|_],_Module,_Call,Name) --> !,
5797		ppterm(Name),
5798		ppcodes(": Operator implemented by axiomatic definition using "),
5799		ppatom(Tag).
5800		translate_eventb_operator2(Functor,_,Module,_Call,Name) -->
5801		ppterm(Name),
5802		ppcodes(": Operator implemented by "),
5803		ppatom(Module),ppcodes(":"),ppatom(Functor).
5804
5805		% example direct definition:
5806		%direct_definition([argument(curM,integer_set(none)),argument(curH,integer_set(none))],truth(none),add(none,identifier(none,curM),multiplication(none,identifier(none,curH),integer(none,60))),[])
5807
5808		pp_eventb_direct_definition_header(Name,Args) -->
5809		ppterm(Name), ppcodes("("),
5810		pp_eventb_operator_args(Args), ppcodes(")").
5811
5812		translate_eventb_direct_definition_header(Name,Args,ResAtom) :-
5813		(pp_eventb_direct_definition_header(Name,Args,C,[])
5814		-> atom_codes(ResAtom,C) ; ResAtom='<<UNABLE TO PRETTY-PRINT OPERATOR HEADER>>').
5815		translate_eventb_direct_definition_body(RawBody,ResAtom) :-
5816		(pp_raw_formula(RawBody,C,[]) -> atom_codes(ResAtom,C) ; ResAtom='<<UNABLE TO PRETTY-PRINT OPERATOR BODY>>').
5817
5818		pp_raw_formula(RawExpr) --> {transform_raw(RawExpr,TExpr)},!, pp_expr(TExpr,_,_LR).
5819		pp_raw_formula(_) --> ppcodes("<<UNABLE TO PRETTY-PRINT>>").
5820
5821
5822		pp_eventb_operator_args([]) --> [].
5823		pp_eventb_operator_args([Arg]) --> !, pp_argument(Arg).
5824		pp_eventb_operator_args([Arg|T]) --> pp_argument(Arg), ppcodes(","),
5825		pp_eventb_operator_args(T).
5826		pp_argument(argument(ID,_RawType)) --> !, ppatom(ID).
5827		pp_argument(identifier(_,ID)) --> !, "<",ppatom(ID),">".
5828		pp_argument(Atom) --> ppatom(Atom).
5829
5830		% ---------------------------------------
5831
5832		% translate a predicate into B machine for manipulation
5833		translate_predicate_into_machine(Pred,MchName,ResultAtom) :-
5834		get_global_identifiers(Ignored,ignore_promoted_constants),
5835		find_typed_identifier_uses(Pred, Ignored, TUsedIds),
5836		get_texpr_ids(TUsedIds,UsedIds),
5837		add_typing_predicates(TUsedIds,Pred,TPred),
5838		set_print_type_infos(all,CHNG),
5839		specfile:set_animation_mode(b), % clear eventb minor mode; to do: set back
5840		translate_bexpression(TPred,PredAtom), %print(res(UsedIds,ResultAtom)),nl,
5841		reset_print_type_infos(CHNG),
5842		convert_and_ajoin_ids(UsedIds,AllIds),
5843		bmachine:get_full_b_machine(_Name,BMachine),
5844		include(relevant_section,BMachine,RelevantSections),
5845		% TO DO: we could filter out enumerate/deferred sets not occuring in Pred
5846		translate_section_list(RelevantSections,SetsParas),
5847		atom_codes(ASP,SetsParas),
5848		ajoin(['MACHINE ', MchName, '\n',ASP,'CONSTANTS ',AllIds,'\nPROPERTIES\n ',PredAtom,'\nEND\n'],ResultAtom).
5849
5850		relevant_section(deferred_sets/_).
5851		relevant_section(enumerated_elements/_).
5852		relevant_section(parameters/_).
5853
5854		:- use_module(library(system),[ datime/1]).
5855		:- use_module(specfile,[currently_opened_file/1]).
5856		:- use_module(probsrc(version), [format_prob_version/1]).
5857		% print a Proof Obligation aka Sequent as a B machine
5858		nested_print_sequent_as_classicalb(Stream,HypsList,Goal,AllHypsList,MchName,ProofInfos) :-
5859		set_suppress_rodin_positions(false,Chng), % ensure we print Rodin labels if available
5860		call_cleanup(nested_print_sequent_as_classicalb_aux(Stream,HypsList,Goal,AllHypsList,MchName,ProofInfos),
5861		reset_suppress_rodin_positions(Chng)).
5862
5863		% convert identifier by adding backquote if necessary for unicode, reserved keywords, ...
5864		convert_id(Atom,CAtom) :- pp_identifier(Atom,Codes,[]), atom_codes(CAtom,Codes).
5865		convert_and_ajoin_ids(UsedIds,AllIdsWithCommas) :-
5866		maplist(convert_id,UsedIds,ConvUsedIds),
5867		ajoin_with_sep(ConvUsedIds,', ',AllIdsWithCommas).
5868
5869		nested_print_sequent_as_classicalb_aux(Stream,HypsList,Goal,AllHypsList,MchName,ProofInfos) :-
5870		conjunct_predicates(HypsList,HypsPred),
5871		conjunct_predicates([Goal|HypsList],Pred),
5872		get_global_identifiers(Ignored,ignore_promoted_constants), % the sets section below will not print the promoted enumerated set constants, they may also not be valid for the selected hyps only
5873		find_typed_identifier_uses(Pred, Ignored, TUsedIds),
5874		get_texpr_ids(TUsedIds,UsedIds),
5875		convert_and_ajoin_ids(UsedIds,AllIds),
5876		bmachine:get_full_b_machine(_Name,BMachine),
5877		include(relevant_section,BMachine,RelevantSections),
5878		% TO DO: we could filter out enumerate/deferred sets not occuring in Pred
5879		translate_section_list(RelevantSections,SetsParas),
5880		set_print_type_infos(all,CHNG),
5881		datime(datime(Yr,Mon,Day,Hr,Min,_Sec)),
5882		format(Stream,'MACHINE ~w~n /* Exported: ~w/~w/~w ~w:~w */~n',[MchName,Day,Mon,Yr,Hr,Min]),
5883		(currently_opened_file(File), bmachine:b_machine_name(Name)
5884		-> format(Stream,' /* Origin: ~w : ~w */~n',[Name,File]) ; true),
5885		write(Stream,' /* '),format_prob_version(Stream), format(Stream,' */~n',[]),
5886		format(Stream,' /* Use static asssertion checking (probcli -cbc_assertions) to look for counter examples */~n',[]),
5887		maplist(format_proof_infos(Stream),ProofInfos),
5888		format(Stream,'~sCONSTANTS~n ~w~nPROPERTIES /* Selected Hypotheses: */~n',[SetsParas,AllIds]),
5889		add_typing_predicates(TUsedIds,HypsPred,HypsT),
5890		current_output(OldStream),
5891		set_output(Stream),
5892		nested_print_bexpr_as_classicalb2(HypsT,s(0)), % TODO: pass stream to this predicate
5893		format(Stream,'~nASSERTIONS /* Proof Goal: */~n',[]),
5894		nested_print_bexpr_as_classicalb2(Goal,s(0)), % TODO: pass stream to this predicate
5895		(AllHypsList = [] -> true
5896		; sort(AllHypsList,SAL), sort(HypsList,SL),
5897		ord_subtract(SAL,SL,RemainingHypsList), % TODO: we could preserve order
5898		conjunct_predicates(RemainingHypsList,AllHypsPred),
5899		find_typed_identifier_uses(AllHypsPred, Ignored, TAllUsedIds),
5900		get_texpr_ids(TAllUsedIds,AllUsedIds),
5901		ord_subtract(AllUsedIds,UsedIds,NewIds), % compute new ids not used in selected hyps and goal
5902		(NewIds = []
5903		-> format(Stream,'OPERATIONS~n CheckRemainingHypotheses = SELECT~n',[])
5904		; ajoin_with_sep(NewIds,', ',NIdLst),
5905		format(Stream,'OPERATIONS~n CheckRemainingHypotheses(~w) = SELECT~n',[NIdLst])
5906		),
5907		nested_print_bexpr_as_classicalb2(AllHypsPred,s(0)), % TODO: pass stream to this predicate
5908		format(Stream,' THEN skip~n END /* CheckRemainingHypotheses */~n',[])
5909		),
5910		set_output(OldStream),
5911		reset_print_type_infos(CHNG),
5912		format(Stream,'DEFINITIONS~n SET_PREF_DISPROVER_MODE == TRUE~n ; SET_PREF_TRY_FIND_ABORT == FALSE~n',[]),
5913		format(Stream,' ; SET_PREF_ALLOW_REALS == FALSE~n',[]),
5914		% The Rodin DisproverCommand.java usually enables CHR;
5915		% TODO: we could also look for options(List) in ProofInfos and check use_chr_solver/true in List, ...
5916		(get_preference(use_clpfd_solver,false) -> format(Stream,' ; SET_PREF_CHR == FALSE~n',[]) ; true),
5917		(get_preference(use_chr_solver,true) -> format(Stream,' ; SET_PREF_CHR == TRUE~n',[]) ; true),
5918		(get_preference(use_smt_mode,true) -> format(Stream,' ; SET_PREF_SMT == TRUE~n',[]) ; true),
5919		(get_preference(use_smt_mode,true) -> format(Stream,' ; SET_PREF_SMT == TRUE~n',[]) ; true),
5920		(get_preference(use_common_subexpression_elimination,true) -> format(Stream,' ; SET_PREF_CSE == TRUE~n',[]) ; true),
5921		(get_preference(smt_supported_interpreter,true) -> format(Stream,' ; SET_PREF_SMT_SUPPORTED_INTERPRETER == TRUE~n',[]) ; true),
5922		format(Stream,'END~n',[]).
5923
5924		format_proof_infos(_,Var) :- var(Var),!.
5925		format_proof_infos(Stream,disprover_result(Prover,Hyps,Result)) :- nonvar(Result),functor(Result,FR,_),!,
5926		format(Stream,' /* ProB Disprover ~w result on ~w : ~w */~n',[Prover,Hyps,FR]).
5927		format_proof_infos(Stream,E) :- format(Stream,' /* ~w */~n',[E]).
5928
5929
5930		% ---------------------------------------
5931
5932
5933		% show non obvious functors
5934		get_texpr_top_level_symbol(TExpr,Symbol,2,infix) :-
5935		translate:binary_infix_symbol(TExpr,Symbol),!.
5936		get_texpr_top_level_symbol(b(E,_,_),Symbol,1,postfix) :-
5937		functor(E,F,1), translate:unary_postfix_in_mode(F,Symbol,_),!.
5938		get_texpr_top_level_symbol(b(E,_,_),Symbol,3,prefix) :-
5939		functor(E,F,Arity), (Arity=3 ; Arity=2), % 2 for exists
5940		quantified_in_mode(F,Symbol),!.
5941		get_texpr_top_level_symbol(b(E,_,_),Symbol,N,prefix) :-
5942		functor(E,F,N),
5943		function_like_in_mode(F,Symbol).
5944
5945		% ---------------
5946
5947		% feedback to user about values
5948		translate_bvalue_kind([],Res) :- !, Res='EMPTY-Set'.
5949		translate_bvalue_kind([_|_],Res) :- !, Res='LIST-Set'.
5950		translate_bvalue_kind(avl_set(A),Res) :- !, avl_size(A,Size), ajoin(['AVL-Set:',Size],Res).
5951		translate_bvalue_kind(int(_),Res) :- !, Res = 'INTEGER'.
5952		translate_bvalue_kind(term(floating(_)),Res) :- !, Res = 'FLOAT'.
5953		translate_bvalue_kind(string(_),Res) :- !, Res = 'STRING'.
5954		translate_bvalue_kind(pred_true,Res) :- !, Res = 'TRUE'.
5955		translate_bvalue_kind(pred_false,Res) :- !, Res = 'FALSE'.
5956		translate_bvalue_kind(fd(_,T),Res) :- !, Res = T.
5957		translate_bvalue_kind((_,_),Res) :- !, Res = 'PAIR'.
5958		translate_bvalue_kind(rec(_),Res) :- !, Res = 'RECORD'.
5959		translate_bvalue_kind(freeval(Freetype,_Case,_),Res) :- !, Res = Freetype.
5960		translate_bvalue_kind(CL,Res) :- custom_explicit_sets:is_interval_closure(CL,_,_),!, Res= 'INTERVAL'.
5961		translate_bvalue_kind(CL,Res) :- custom_explicit_sets:is_infinite_explicit_set(CL),!, Res= 'INFINITE-Set'.
5962		translate_bvalue_kind(closure(_,_,_),Res) :- !, Res= 'SYMBOLIC-Set'.
5963
5964
5965		% ---------------------------------------