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