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