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