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