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