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