1		% (c) 2009-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2		% Heinrich Heine Universitaet Duesseldorf
3		% This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5		:- module(specfile, [
6		specfile_possible_trans_name/2, specfile_possible_trans_name_for_successors/2,
7		specfile_trans/6,
8		prepare_state_for_specfile_trans/3, prepare_state_for_specfile_trans/4,
9		extract_infos_from_prepared_state/2,
10
11		property/2, elementary_prop/2,
12
13		partial_trans/4, specfile_trans_or_partial_trans/7,
14
15		animation_mode/1, set_animation_mode/1, add_animation_minor_mode/1,
16		animation_minor_mode/1, set_animation_minor_mode/1, remove_animation_minor_mode/0,
17		unset_animation_minor_modes/1, reset_animation_minor_modes/1,
18		b_mode/0, z_mode/0, b_or_z_mode/0, b_or_z_mode/1,
19		eventb_mode/0,
20		classical_b_mode/0,
21		csp_mode/0, csp_mode/1,
22		csp_with_bz_mode/0, z_or_tla_minor_mode/0,
23		process_algebra_mode/0,
24		xtl_mode/0,
25		sequent_prover_mode/0,
26		b_syntax_available_for_source/0,
27
28		type_check_csp_and_b/0,
29
30		currently_opened_file/1, % only true for successfully opened files
31		currently_opened_file_status/2, % second parameter: success or failure
32		currently_opened_specification_name/1,
33		%reset_currently_opened_file/0,
34		set_currently_opened_file/1, set_currently_opened_b_file/1,
35		set_failed_to_open_file/1,
36		set_minor_animation_mode_from_file/1,
37		set_currently_opening_file/1,
38		set_currently_opened_package/1,
39		spec_file_has_been_successfully_loaded/0,
40		b_absolute_file_name_relative_to_opened_file/2,
41
42		state_corresponds_to_initialised_b_machine/1, state_corresponds_to_initialised_b_machine/2,
43		state_corresponds_to_fully_setup_b_machine/1, state_corresponds_to_fully_setup_b_machine/2,
44		state_corresponds_to_set_up_constants/1,
45		state_corresponds_to_set_up_constants/2, state_corresponds_to_set_up_constants_only/2,
46		extract_variables_from_state/2, extract_variables_from_state_as_primed/2,
47		current_b_expression/1,
48		get_current_state_for_b_formula/2, get_state_for_b_formula/3,
49
50		get_operation_name/2, get_operation_internal_name/2,
51		translate_operation_name/2,
52		get_operation_arguments/2, get_operation_return_values_and_arguments/3,
53		get_operation_description/2, get_operation_description_for_transition/4,
54		get_operation_description_for_transition_id/3,
55		build_up_b_real_operation/2,
56		expand_const_and_vars/3, expand_const_and_vars_to_full_store/2,
57		expand_to_constants_and_variables/3,
58
59		get_specific_time_out_for_operation/2,
60		get_specific_max_operations_for_operation/2,
61		max_operations_zero_for_operation/1,
62		max_operations_zero_for_setup_constants/0, max_operations_zero_for_initialisation/0,
63		compute_operation_effect_max/6, % has replaced compute_operation_effect/5
64		create_setup_constants_operation/3,
65		get_internal_representation/1, get_internal_representation/4,
66		get_possible_event/1, get_feasible_event/1,
67		get_possible_language_specific_top_level_event/3,
68		get_specification_description/2,
69		get_local_state_for_operation_transition/3,
70		get_local_states_for_operation_transition/4, create_local_store_for_operation/4
71		]).
72
73		:- use_module(tools).
74
75		:- use_module(module_information).
76		:- module_info(group,animator).
77		:- module_info(description,'This module computes transitions and properties depending on the current animator mode.').
78
79		:- use_module(library(lists)).
80		%:- use_module(library(avl)).
81		%:- use_module(library(clpfd)).
82
83		:- use_module(debug).
84		:- use_module(b_interpreter).
85		:- use_module(preferences).
86		:- use_module(self_check).
87		:- use_module(error_manager).
88		:- use_module(translate).
89		:- use_module(succeed_max,[succeed_max_call_id/3]).
90
91		:- use_module(store,[empty_state/1]).
92		:- use_module(bmachine).
93		:- use_module(bsyntaxtree).
94		:- use_module(xtl_interface).
95
96
97		%% :- use_module(delay).
98
99		:- use_module(value_persistance, [load_constants/2]).
100
101		:- set_prolog_flag(double_quotes, codes).
102
103		/* --------------------------------- */
104
105
106
107
108		/* --------------------------------- */
109		/* ANIMATION & TEMPORAL VERIFICATION */
110		/* --------------------------------- */
111
112
113		:- dynamic animation_mode/1, animation_minor_mode/1.
114		% not marking as volatile; otherwise we startup with no animation_mode set
115		% not all parts of ProB can deal with this at the moment
116		%:- volatile animation_mode/1, animation_minor_mode/1.
117
118		animation_mode(b).
119		% possible values: b, csp, xtl, z, csp_and_b, promela
120		% animation_minor_mode: possible values alloy, event_b, tla, z (classical B if no animation_minor_mode fact)
121
122		b_mode :- animation_mode(X), (X=b ; X=csp_and_b).
123		z_mode :- animation_mode(X), (X=b ; X=csp_and_b), animation_minor_mode(z).
124	?	classical_b_mode :- b_mode, (animation_minor_mode(Mode) -> classical_minor_mode(Mode) ; true).
125		classical_minor_mode(rules_dsl).
126
127		eventb_mode :-
128		animation_mode(X), (X=b ; X=csp_and_b),
129		animation_minor_mode(eventb).
130		csp_with_bz_mode :- animation_mode(csp_and_b).
131		z_or_tla_minor_mode :- animation_minor_mode(X), (X=tla ; X=z).
132
133		csp_mode :- animation_mode(X), csp_mode(X).
134		csp_mode(cspm).
135		csp_mode(csp_and_b).
136
137		xtl_mode :- animation_mode(xtl).
138		sequent_prover_mode :- animation_mode(xtl), animation_minor_mode(sequent_prover).
139
140		b_or_z_mode :-
141		(animation_mode(X) -> (X=b -> true ; X=csp_and_b)). % basically the same as b_mode
142		b_or_z_mode(b). b_or_z_mode(csp_and_b).
143
144		% is B syntax (ASCII/Unicode available for source files)
145		b_syntax_available_for_source :-
146		b_or_z_mode,
147		(animation_minor_mode(X) -> X=event_b ; true).
148
149		process_algebra_mode :- %Note: also covers xtl (Promela, CCS interpreters; see test 756); used for translating events (tau, tick, io(...))
150		animation_mode(X), X \= b,
151		\+ ((X=xtl, xtl_get_definition_string('PROCESS_ALGEBRA_MODE',false))).
152
153		set_animation_mode(X) :-
154		retractall(animation_mode(_)),
155		remove_animation_minor_mode,
156		assertz(animation_mode(X)).
157
158		set_animation_minor_mode(X) :-
159		remove_animation_minor_mode,
160		assertz(animation_minor_mode(X)).
161		remove_animation_minor_mode :-
162		retractall(animation_minor_mode(_)).
163
164		% use to temporarily unset animation minor mode:
165		:- use_module(library(lists),[maplist/2]).
166		unset_animation_minor_modes(L) :- findall(X,retract(animation_minor_mode(X)),L).
167		reset_animation_minor_modes(L) :- maplist(add_animation_minor_mode,L).
168
169		add_animation_minor_mode(X) :-
170		(animation_minor_mode(X) -> true ; assertz(animation_minor_mode(X))).
171
172
173		:- dynamic currently_opened_file_status/2.
174		:- volatile currently_opened_file_status/2.
175		%currently_opened_file(none).
176
177		:- use_module(bmachine,[b_machine_name/1]).
178		currently_opened_specification_name(Name) :-
179		(b_or_z_mode -> b_machine_name(Name)
180		; currently_opened_file(File),
181		get_modulename_filename(File,Name)
182		).
183
184		reset_currently_opened_file :- retractall(currently_opened_file_status(_,_)).
185		reset_specfile :- reset_currently_opened_file,
186		retractall(animation_minor_mode(_)).
187		:- use_module(eventhandling,[register_event_listener/3]).
188		:- register_event_listener(clear_specification,reset_specfile,
189		'Reset Specfile Currently Opened File.').
190
191		% call if a spec was not loaded from file but from package (e.g., via socket / prob2)
192		set_currently_opened_package(Type) :-
193		set_currently_opened_file(package(Type)).
194
195		% indicates we are in the process of opening a file
196		set_currently_opening_file(File) :-
197		reset_currently_opened_file,
198		assertz(currently_opened_file_status(File,opening)),
199		set_minor_animation_mode_from_file(File).
200
201		:- use_module(tools,[get_filename_extension/2]).
202		set_minor_animation_mode_from_file(File) :-
203		get_filename_extension(File,Extension),
204		file_extension_mode(Extension,Major,Minor),!,
205		animation_mode(CurMajor),
206		(CurMajor=Major
207		-> (animation_minor_mode(CurMinor)
208		-> (CurMinor=Minor -> true
209		; add_warning(specfile,'Minor animation mode incompatible with file:',CurMinor:File)
210		)
211		; Minor=none -> true
212		; set_animation_minor_mode(Minor)
213		)
214		; add_warning(specfile,'Major animation mode incompatible with file:',CurMajor:File)
215		).
216		set_minor_animation_mode_from_file(File) :- add_warning(specfile,'Unknown file extension:',File).
217
218		:- use_module(probsrc(tools_platform), [host_platform/1]).
219		file_extension_mode(mch,b,none). % classical b, could also be csp_and_b
220		file_extension_mode(ref,b,none).
221		file_extension_mode(imp,b,none).
222		file_extension_mode(def,b,none).
223		file_extension_mode(sys,b,none).
224		file_extension_mode(rmch,b,rules_dsl).
225		file_extension_mode(prob,b,none). % Here we cannot infer the mode; TODO: in future store this info in the .prob file
226		file_extension_mode(tla,b,tla).
227		file_extension_mode(fuzz,b,z).
228		file_extension_mode(tex,b,z).
229		file_extension_mode(eventb,b,eventb).
230		file_extension_mode(pl,xtl,none). % can be proof obligation files (sequent_prover minor mode)
231		file_extension_mode('P',xtl,none).
232		file_extension_mode('p',xtl,none) :- host_platform(windows),
233		add_message(specfile,'Lower-case file extension .p treated as .P for XTL mode').
234		file_extension_mode(als,b,alloy).
235		file_extension_mode(csp,cspm,none).
236		file_extension_mode(cspm,cspm,none).
237
238		% store currently openend specification file and set B minor animation mode
239		set_currently_opened_b_file(File) :-
240		set_currently_opened_file(File),
241		set_minor_animation_mode_from_file(File).
242
243		set_currently_opened_file(File) :-
244		reset_currently_opened_file,
245		assertz(currently_opened_file_status(File,success)).
246
247		set_failed_to_open_file(File) :-
248		reset_currently_opened_file,
249		assertz(currently_opened_file_status(File,failure)).
250
251		currently_opened_file(File) :- currently_opened_file_status(File,success).
252
253
254		:- use_module(tools,[safe_absolute_file_name/3, get_parent_directory/2]).
255		% open a file relateive to the main B file
256		b_absolute_file_name_relative_to_opened_file(File,AbsFileName) :-
257		currently_opened_file_status(MainFileName,_Status), % _Status=failure happens when error during loading
258		get_parent_directory(MainFileName,Directory),
259		safe_absolute_file_name(File,AbsFileName,[relative_to(Directory)]).
260
261		spec_file_has_been_successfully_loaded :- currently_opened_file(_).
262
263		:- use_module(bmachine,[b_machine_has_variables/0]).
264		% true if state corresponds to an initialised B machine
265		state_corresponds_to_initialised_b_machine(const_and_vars(_,_)) :- !,
266		b_or_z_mode.
267		state_corresponds_to_initialised_b_machine(expanded_const_and_vars(_,_,_,_)) :- !,
268		b_or_z_mode.
269		state_corresponds_to_initialised_b_machine(expanded_vars(_,_)) :- !,
270		b_or_z_mode.
271		state_corresponds_to_initialised_b_machine([]).
272		state_corresponds_to_initialised_b_machine([_|_]).
273		state_corresponds_to_initialised_b_machine(csp_and_b(_,BState)) :-
274		csp_with_bz_mode,
275		state_corresponds_to_initialised_b_machine(BState).
276
277
278		% check if state corresponds to an initialised B machine, and if so return expanded State
279		state_corresponds_to_initialised_b_machine(const_and_vars(ConstID,Vars),State) :- !,
280		b_or_z_mode, expand_const_and_vars(ConstID,Vars,State).
281		state_corresponds_to_initialised_b_machine(expanded_const_and_vars(_ConstID,_Vars,FullStore,_),State) :- !,
282		% generated by prepare_state_for_specfile_trans
283		State=FullStore.
284		state_corresponds_to_initialised_b_machine(expanded_vars(FullStore,_),State) :- !,
285		% generated by prepare_state_for_specfile_trans
286		State=FullStore.
287		state_corresponds_to_initialised_b_machine([],[]).
288		state_corresponds_to_initialised_b_machine([H|T],[H|T]).
289		state_corresponds_to_initialised_b_machine(csp_and_b(_,BState),State) :-
290		csp_with_bz_mode,
291		state_corresponds_to_initialised_b_machine(BState,State).
292
293		% check if all variables, constants setup; also allows concrete_constants if no variables exist
294		state_corresponds_to_fully_setup_b_machine(concrete_constants(_)) :- !, b_or_z_mode,
295		\+ b_machine_has_variables.
296		state_corresponds_to_fully_setup_b_machine(X) :- state_corresponds_to_initialised_b_machine(X).
297
298		state_corresponds_to_fully_setup_b_machine(concrete_constants(Constants),State) :- !, b_or_z_mode,
299		\+ b_machine_has_variables, State=Constants.
300		state_corresponds_to_fully_setup_b_machine(X,State) :- state_corresponds_to_initialised_b_machine(X,State).
301
302		% check if we only have constants, no variable values yet
303		state_corresponds_to_set_up_constants_only(root,State) :- !, animation_mode(b),
304		\+ b_machine_has_constants_or_properties, State=[]. % relevant for test 960
305		state_corresponds_to_set_up_constants_only(concrete_constants(Constants),State) :- !,
306		b_or_z_mode, State=Constants.
307		state_corresponds_to_set_up_constants_only(csp_and_b(_,BState),State) :- !,
308		csp_with_bz_mode,
309		state_corresponds_to_set_up_constants_only(BState,State).
310
311		state_corresponds_to_set_up_constants(const_and_vars(_,_)) :- !. % avoid expansion
312		state_corresponds_to_set_up_constants(X) :- state_corresponds_to_set_up_constants(X,_).
313
314		state_corresponds_to_set_up_constants(const_and_vars(ConstID,Vars),State) :- !,
315		b_or_z_mode, expand_const_and_vars(ConstID,Vars,State).
316		state_corresponds_to_set_up_constants(expanded_const_and_vars(_ConstID,_Vars,FullStore,_),State) :- !,
317		% generated by prepare_state_for_specfile_trans
318		State=FullStore.
319		state_corresponds_to_set_up_constants(expanded_vars(FullStore,_),State) :- !,
320		% generated by prepare_state_for_specfile_trans
321		State=FullStore.
322		state_corresponds_to_set_up_constants(concrete_constants(Constants),State) :- !,
323		b_or_z_mode, State=Constants.
324		state_corresponds_to_set_up_constants(csp_and_b(_,BState),State) :- !,
325		csp_with_bz_mode,
326		state_corresponds_to_set_up_constants(BState,State).
327		state_corresponds_to_set_up_constants([],State) :- !, State=[],
328		animation_mode(b).
329		state_corresponds_to_set_up_constants(State,RState) :-
330		animation_mode(b),
331		(State = root -> \+ b_machine_has_constants_or_properties,RState=[] ; RState=State).
332
333		:- use_module(state_space,[current_expression/2]).
334		current_b_expression(CurBState) :-
335		current_expression(_CurID,CurState),
336		state_corresponds_to_set_up_constants(CurState,CurBState).
337
338
339
340		:- use_module(state_space, [current_state_id/1]).
341		:- use_module(bmachine, [determine_type_of_formula/2]).
342		% get a state sufficient to evaluate a given formula (expression or predicate)
343		% it will give an error is the machine is not sufficiently initialised
344		get_current_state_for_b_formula(TypedExpr,BState) :-
345		current_state_id(CurID),
346		get_state_for_b_formula(CurID,TypedExpr,BState).
347		get_state_for_b_formula(StateID,TypedExpr,BState) :-
348		(formula_class(TypedExpr) -> Type=TypedExpr % user already provided formula class
349		; determine_type_of_formula(TypedExpr,Type)), % TODO: extract used ids and only expand those that are required
350		get_state(Type,StateID,TypedExpr,BState).
351
352		formula_class(requires_nothing).
353		formula_class(requires_constants).
354		formula_class(requires_variables).
355
356		:- use_module(probsrc(state_space),[get_constants_state_for_id/3]).
357		get_state(requires_nothing,_ID,_TE,[]).
358		get_state(requires_constants,StateID,TypedExpr,BState) :-
359		(get_constants_state_for_id(StateID,[allow_variable_list],BState) -> true
360		; ajoin(['Please setup constants first, cannot evaluate (in state ',StateID,') :'],Msg),
361		add_error(get_state,Msg,TypedExpr,TypedExpr),fail).
362		get_state(requires_variables,StateID,TypedExpr,BState) :-
363		my_visited_expression(StateID,State),
364		(state_corresponds_to_initialised_b_machine(State,BState) -> true ;
365		ajoin(['Please initialise machine first, cannot evaluate (in state ',StateID,') :'],Msg),
366		add_error(get_state,Msg,TypedExpr,TypedExpr),fail).
367		% TO DO: we could try and get only those identifiers that are really used
368
369		:- use_module(state_space,[visited_expression/2]).
370		my_visited_expression(root,S) :- !,
371		S=root. % ensure we succeed even if no state space set (e.g. when no machine provided to probcli)
372		my_visited_expression(StateID,State) :- visited_expression(StateID,State).
373
374		/* TRANSITIONS */
375
376		:- use_module(tools_meta,[call_residue/2]).
377		% ---------------------------------------------------
378
379
380		% Tries to find successor state for Op in State DB. Fails, if no solution is possible
381		% Input: State DB, Operation Op
382		% Output: DB2 the sucessor state
383		% Residue: Unfinished co-routines (should not happen!)
384		%specfile_trans(DB,Op,DB2,[]) :- !, specfile:i_transition(DB,Op,DB2).
385		specfile_trans(DB,OpName,Op,DB2,TransInfo,Residue) :-
386		% i_transition(DB,OpName,Op,DB2,TransInfo), Residue = []. % is faster, but no residue checking
387		animation_mode(MODE),
388	?	call_residue(i_transition(MODE,DB,OpName,Op,DB2,TransInfo),Residue).
389
390		i_transition(b,State,OpName,Op,NewState,TransInfo) :- !,
391	?	b_trans(State,OpName,Op,NewState,TransInfo).
392		i_transition(xtl,State,OpName,Op,NewState,TransInfo) :- !,
393	?	xtl_transition(State,Op,NewState,TransInfo), functor(Op,OpName,_).
394		i_transition(cspm,State,_OpName,Op,NewState,[]) :- !,
395		% Note: the OpName is ignored: we cannot make use of it
396	?	cspm_transition(State,Op,NewState).
397		%i_transition(promela,State,_OpName,Op,NewState,[]) :- !,
398		% promela_transition(State,Op,NewState).
399		% ; MODE=smv -> smv_transition(State,Op,NewState),TransInfo=[]
400		i_transition(csp_and_b,State,OpName,Op,NewState,TransInfo) :- !,
401		% Note: the OpName is either the name of a B operation or '$CSP' (or a variable)
402	?	csp_and_b_transition(State,OpName,Op,NewState,TransInfo).
403
404
405		% if you call specfile_trans multiple times for the same state, it is
406		% more efficient to call this predicate first once
407		prepare_state_for_specfile_trans(const_and_vars(ConstID,Vars),CurID,R) :- !, %print(expanding_const(ConstID)),nl,
408		R = expanded_const_and_vars(ConstID,Vars,FullStore,Infos),
409		expand_const_and_vars(ConstID,Vars,FullStore), %, print(full(FullStore)),nl.
410		prepare_infos(FullStore,CurID,Infos).
411		prepare_state_for_specfile_trans(FullStore,CurID,R) :- FullStore=[_|_],
412		prepare_infos(FullStore,CurID,Infos), Infos \=[],
413		!,
414		R = expanded_vars(FullStore,Infos).
415		prepare_state_for_specfile_trans(csp_and_b(CSP,BStore),CurID,csp_and_b(CSP,Res)) :- !,
416		prepare_state_for_specfile_trans(BStore,CurID,Res).
417		prepare_state_for_specfile_trans(X,_,X).
418
419		% a version with a memo argument to store expanded constants
420		prepare_state_for_specfile_trans(const_and_vars(ConstID,Vars),CurID,MEMO,R) :- !, %print(expanding_const(ConstID)),nl,
421		R = expanded_const_and_vars(ConstID,Vars,FullStore,Infos),
422		(nonvar(MEMO),MEMO = [ConstID/ConstantsStore]
423		% constants have already been previously extracted; e.g., in model_checker loop
424		-> %tools_printing:print_term_summary(memo(ConstID,ConstantsStore)),nl,
425		append(Vars,ConstantsStore,FullStore) % simply reuse expanded constants in MEMO
426		% used to be constants first, but has to be compatible with b_initialise_machine2 and expand_const_and_vars/3
427		; % expand_const_and_vars/3 inlined (so as to obtain ConstantsStore
428		visited_expression(ConstID,concrete_constants(ConstantsStore)), %% This can take a while if the Constants are big !
429		% print(no_memo(ConstID,MEMO)),tools_printing:print_term_summary(ConstantsStore),nl,
430		append(Vars,ConstantsStore,FullStore),
431		(var(MEMO)
432		-> MEMO=[ConstID/ConstantsStore] % store expanded constants to avoid unpacking again
433		; true)
434		), %, print(full(FullStore)),nl.
435		prepare_infos(FullStore,CurID,Infos).
436		prepare_state_for_specfile_trans(FullStore,CurID,_,R) :- FullStore=[_|_],
437		prepare_infos(FullStore,CurID,Infos), Infos \=[], !,
438		R = expanded_vars(FullStore,Infos).
439		prepare_state_for_specfile_trans(csp_and_b(CSP,BStore),CurID,MEMO,csp_and_b(CSP,Res)) :- !,
440		prepare_state_for_specfile_trans(BStore,CurID,MEMO,Res).
441		prepare_state_for_specfile_trans(X,_,_,X). % TODO: prepare infos as well if we have no constants
442
443		:- use_module(state_packing,[pack_state/2, get_packed_b_state_with_uncompressed_lists/2]).
444		% store some operation independent infos which are useful
445		prepare_infos(FullStore,CurID,Infos) :- CurID \= root,
446		(get_preference(operation_reuse_setting,false)
447		-> Infos = []
448		% TO DO: check if we should enable this: get_preference(use_state_packing,true)
449		% TODO: we could check if there are operations which do not write all variables
450		; Infos=[packed_state/PackedList, state_id/CurID],
451		(CurID \= unknown, state_space:packed_visited_expression(CurID,PS),
452		get_packed_b_state_with_uncompressed_lists(PS,PackedList) % replace '$cst_vars' and compressed lists
453		-> true %,write('+')
454		; format('prepare_infos for state ~w: need to pack_values~n',[CurID]), % should ideally not happen
455		pack_state(FullStore,PS), % precompute state packing; will be re-used multiple times
456		get_packed_b_state_with_uncompressed_lists(PS,PackedList)
457		)
458		).
459
460		% extract pre-computed infos
461		extract_infos_from_prepared_state(expanded_const_and_vars(_,_,_,Infos),Res) :- !, Res=Infos.
462		extract_infos_from_prepared_state(expanded_vars(_,Infos),Res) :- !, Res=Infos.
463		extract_infos_from_prepared_state(_,[]).
464
465		remove_infos_from_prepared_state(expanded_const_and_vars(C,V,_,_),Res) :- !, Res=const_and_vars(C,V).
466		remove_infos_from_prepared_state(expanded_vars(V,_),R) :- !, R=V.
467		remove_infos_from_prepared_state(S,S).
468
469		% extract initialised variables from a state
470		extract_variables_from_state(const_and_vars(_,V),R) :- !,R=V.
471		extract_variables_from_state(expanded_const_and_vars(_,V,_,_),R) :- !,R=V.
472		extract_variables_from_state(expanded_vars(V,_),R) :- !,R=V.
473		extract_variables_from_state([],[]).
474		extract_variables_from_state([H|T],[H|T]).
475
476		:- use_module(probsrc(btypechecker),[prime_atom0/2]). % add $0 at end of variable
477		prime_binding(bind(ID,V),bind(PID,V)) :- prime_atom0(ID,PID).
478
479		extract_variables_from_state_as_primed(SrcState,PrimedVarBindings) :-
480		extract_variables_from_state(SrcState,VarVals),
481		maplist(prime_binding,VarVals,PrimedVarBindings).
482
483
484		/* can be attempted if trans fails to attempt to use partially computed transitions */
485		partial_trans(DB,Op,DB2,Residue) :-
486		call_residue(partial_i_transition(DB,Op,DB2),Residue).
487
488		partial_i_transition(root,'$partial_setup_constants',concrete_constants(ConstantsStore)) :-
489		animation_mode(b),
490		set_error_context(operation('$partial_setup_constants',root)),
491		b_interpreter:b_partial_set_up_concrete_constants(ConstantsStore).
492
493		% a predicate which automatically calls partial_trans :
494		specfile_trans_or_partial_trans(DB,OpName,Op,DB2,TransInfo,Residue,Partial) :-
495	?	if(specfile_trans(DB,OpName,Op,DB2,TransInfo,Residue),Partial=false,
496		(OpName='$setup_constants', % OpName is often an input argument here
497		TransInfo=[], Partial = true,
498		partial_trans(DB,Op,DB2,Residue))).
499
500		/* build up skeletons of possible operations; to be used before time_out call is made */
501		% currently only used in zmq worker.pl
502		specfile_possible_trans_name(State,OpName) :- animation_mode(MODE),
503		(MODE=b -> b_possible_trans_name(State,OpName)
504		; MODE = csp_and_b -> csp_b_possible_trans_name(State,OpName)
505		; setup_transition_skeleton(MODE,OpName) /* TO DO: add more possible skeletons */
506		).
507
508		% only set up skeletons if it is worth it for computing all successors
509		% e.g., currently it is not worth it to setup skeletons for either CSP or CSP||B (due to renaming,... we cannot predict which parts of a CSP process can be excluded)
510		specfile_possible_trans_name_for_successors(State,OpName) :- animation_mode(MODE),
511		(MODE=b
512	?	-> b_possible_trans_name(State,OpName)
513		; setup_transition_skeleton(MODE,OpName)
514		).
515
516		setup_transition_skeleton(_,_). /* TO DO: add more possible skeletons ? */
517
518		:- use_module(library(random)).
519		b_possible_trans_name(root,OpName) :- !,
520		(b_machine_has_constants_or_properties
521		-> OpName = '$setup_constants'
522		; OpName = '$initialise_machine').
523		b_possible_trans_name(concrete_constants(_),OpName) :- !, OpName = '$initialise_machine'.
524		b_possible_trans_name(_State,OpName) :-
525		(preferences:preference(randomise_operation_order,true),random(1,3,1)
526		-> b_machine_operation_names_in_reverse_order(OpName) ; true),
527		%b_get_machine_operation(OpName,_Res,_Params,_,_,_).
528	?	b_top_level_feasible_operation(OpName). % TO DO: we could link also with cbc feasibility analysis if carried out
529		% we could check: b_operation_cannot_modify_state(OpName) given a preference, in particular for SAFETY_MODEL_CHECK when operation already covered
530
531		csp_b_possible_trans_name(csp_and_b_root,OpName) :- !,
532		(b_machine_has_constants_or_properties
533		-> OpName = 'tau($setup_constants)'
534		; OpName = 'tau($initialise_machine)').
535		csp_b_possible_trans_name(concrete_constants(_),OpName) :- !,
536		OpName = 'tau($initialise_machine)'.
537		csp_b_possible_trans_name(State,OpName) :-
538		b_possible_trans_name(State,OpName).
539		% TO DO: add non-synchronised channels
540
541		% --------------
542
543		:- use_module(probcspsrc(haskell_csp),[channel_type_list/2, symbol/4]).
544		:- use_module(debug).
545		% check whether a currently open CSP is type compatible with a loaded B machine
546		type_check_csp_and_b :- animation_mode(csp_and_b), debug_println(9,type_check_csp_and_b),
547	?	b_get_machine_operation(ChannelOpName,Res,Params,_,_,_), append(Params,Res,ParamsRes),
548		channel_type_list(ChannelOpName,CSPTypeList),
549		% TO DO: also check B variable names which match channel name
550		debug_println(9,checking_synchronised_channel(ChannelOpName,ParamsRes,CSPTypeList)),
551		l_check_compatibility(ParamsRes,CSPTypeList,ChannelOpName),
552		fail.
553		type_check_csp_and_b.
554
555		%convert_csp_type_to_list(type(T),R) :- convert_csp_type_to_list2(T,R).
556		%convert_csp_type_to_list2(dotUnitType,[]).
557		%convert_csp_type_to_list2(dotTupleType(T),T).
558
559		l_check_compatibility([],[],_) :- !.
560		l_check_compatibility([B|BT],[CSP|CSPT],ChannelOpName) :- !, check_compatibility(B,CSP,ChannelOpName),
561		l_check_compatibility(BT,CSPT,ChannelOpName).
562		l_check_compatibility([],CSP,ChannelOpName) :- !,
563		add_error(type_check_csp_and_b,'CSP Channel has too many parameters: ', ChannelOpName:CSP).
564		l_check_compatibility(B,[],ChannelOpName) :- !,
565		print('* CSP Channel has too few parameters: '), print(ChannelOpName),nl,
566		print('* B Arguments will be ignored: '), l_print_bexpr_or_subst(B),nl.
567		%add_error(type_check_csp_and_b,'CSP Channel has too few parameters: ', ChannelOpName:B).
568
569		check_compatibility(b(identifier(ID),TYPE,INFO),CSP_TYPE,ChannelOpName) :- !,
570		(type_ok(TYPE,CSP_TYPE) -> true ;
571		% TO DO: pretty print B and CSP Types
572		add_error(type_check_csp_and_b,'Incompatible types between B and CSP: ',ChannelOpName:ID:(TYPE:CSP_TYPE),b(identifier(ID),TYPE,INFO))
573		).
574		check_compatibility(B,CSP,ChannelOpName) :- !,
575		add_internal_error('Illegal types: ',check_compatibility(B,CSP,ChannelOpName)).
576
577		% TO DO: needs to be refined much more;
578		type_ok(Type,CSPType) :-
579		(type_ok2(Type,CSPType) -> true
580		; add_error(type_check_csp_and_b,'Cannot be converted (B:CSP): ',Type:CSPType),fail).
581		type_ok2(boolean,X) :- !, is_csp_boolean_type(X).
582		type_ok2(integer,X) :- !, is_csp_integer_type(X).
583		type_ok2(string,CSP) :- !,is_csp_global_set_type(CSP,string).
584		type_ok2(set(T),CSP) :- !, is_csp_set_type(CSP,T).
585		% TO DO: what if we have set(couple(integer,T)) instead of seq(T) ?
586		% rye
587		% check set(couple(integer,T)) (seq type) in B
588		type_ok2(seq(T),CSP) :- !, is_csp_seq_type(CSP,T).
589		type_ok2(couple(A,B),CSP) :- !, is_csp_couple_type(CSP,A,B).
590		type_ok2(global(GS),CSP) :- !,is_csp_global_set_type(CSP,GS).
591		type_ok2(X,Y) :- print(unknown(X,Y)),nl.
592
593		is_csp_couple_type(setValue([na_tuple([A|Rest])|_]),TA,TB) :- type_ok(TA,setValue([A])),
594		check_rest_couple_els(Rest,TB).
595		is_csp_couple_type(typeTuple([A|Rest]),TA,TB) :- type_ok(TA,A), check_rest_couple(Rest,TB).
596
597		check_rest_couple_els([B],TB) :- !, type_ok(TB,setValue([B])).
598		check_rest_couple_els([B1|BRest],couple(TB1,TBRest)) :- type_ok(TB1,setValue([B1])),
599		check_rest_couple_els(BRest,TBRest).
600		check_rest_couple([B],TB) :- !, type_ok(TB,B).
601		check_rest_couple([B1|BRest],couple(TB1,TBRest)) :- type_ok(TB1,B1),
602		check_rest_couple(BRest,TBRest).
603
604		% rye
605		% check if it is couple(integer, T) type and return T in 2nd arguments
606		couple_int(couple(integer, T), T). % possible sequence
607
608		% rye: it's not correct to check only Head
609		% % for example, for CSP type, {{}, {(1,2),(2,3)}}. Its head is emptyset, but the second one is set of tuple
610		is_csp_set_type('Set'([H|_]),Type) :- type_ok(Type,H). % just check Head
611		% check the 2nd element in set in case the 1st is emptyset
612		is_csp_set_type(setValue([_|T]),Type) :-
613		T = [H1 | _], !,
614		% if it is set(couple(integer, T)), it can be a sequence type
615		(couple_int(Type, TH1) -> is_csp_seq_type(setValue(T), TH1)
616		; type_ok(Type,H1)
617		). % check the 2nd
618		% if it is only one element in set, just check the head
619		is_csp_set_type(setValue([H|T]),Type) :-
620		(couple_int(Type, TH1) -> is_csp_seq_type(setValue([H|T]), TH1)
621		; type_ok(Type,H)
622		). % just check Head
623
624		is_csp_seq_type('Seq'(H),Type) :- type_ok(Type,H).
625		is_csp_seq_type(setValue([H|_]),Type) :- H=list(L), is_csp_list(L,Type).
626		is_csp_list([],_).
627		is_csp_list([H|_],Type) :- type_ok(Type,setValue([H])).
628
629		is_csp_boolean_type(boolType).
630		is_csp_boolean_type(setValue([H|_])) :- is_csp_boolean_value(H).
631		is_csp_boolean_value(true).
632		is_csp_boolean_value(false).
633
634		is_csp_integer_type(intType).
635		is_csp_integer_type(setFromTo(_,_)).
636		is_csp_integer_type(setFrom(_)).
637		is_csp_integer_type(setValue([int(_)|_])).
638
639		is_csp_global_set_type(dataType(_),_GS). % TO DO CHECK MEMBERS
640		is_csp_global_set_type(setValue([]),_GS). % TO DO CHECK MEMBERS
641		is_csp_global_set_type(setValue([_|_]),_GS). % TO DO CHECK MEMBERS
642
643		% --------------
644
645
646		:- use_module(bmachine,[b_get_machine_operation/4]).
647		:- use_module(bsets_clp,[tuple_of/3]).
648		% compute transitions for a CSP || B specification
649		% Note: the OpName is either the name of a B machine operation (even if hidden) or '$CSP' (useful for ltsmin)
650		csp_and_b_transition(root,OpName,Op,NewState,TransInfo) :- !,
651		Op = start_cspm_MAIN, OpName=Op, NewState = csp_and_b_root,TransInfo = [].
652		csp_and_b_transition(csp_and_b_root,OpName,Trans,NewState,TransInfo) :- !,
653		Trans = tau(Op), OpName = '$CSP',
654	?	b_trans(root,_,Op,InitialBState,TransInfo),
655		(InitialBState = concrete_constants(_)
656		-> NewState = InitialBState
657		; csp_initialisation_for_b(InitialCSPState),
658		NewState = csp_and_b(InitialCSPState,InitialBState)
659		).
660		csp_and_b_transition(concrete_constants(C),OpName,Trans,NewState,TransInfo) :- !,
661		Trans = tau(Op), OpName = '$CSP',
662		b_trans(concrete_constants(C),_,Op,InitialBState,TransInfo),
663		csp_initialisation_for_b(InitialCSPState),
664		NewState = csp_and_b(InitialCSPState,InitialBState).
665		csp_and_b_transition(csp_and_b(CSPState,BState),OpName,EventVisibleToUser,csp_and_b(NewCSP,NewB),TransInfo) :-
666		!,
667	?	csp_transition_for_b(CSPState,ChOpName,ChArgs,CSPAction,NewCSP),
668		% TO DO: split up csp_transition_for_b: into two parts; second part converts datatypes and only called if linking op exists
669		%% print(csp_trans(ChOpName,ChArgs)),nl, %%
670		length(ChArgs,Len), length(OpArgs,Len),
671	?	b_transition_for_csp(ChOpName,CSPAction,ChArgs,OpArgs,BState,OpName,Operation,NewB,TransInfo),
672	?	hide_csp_event(CSPAction,Operation,EventVisibleToUser).
673		csp_and_b_transition(State,'$CSP',Op,NewState,[]) :-
674		% we have a pure CSP state: use CSP-M transition
675	?	cspm_transition(State,Op,NewState).
676
677		:- use_module(bmachine,[b_is_variable/1,b_is_constant/1]).
678		% compute the B counterpart for a CSP transition:
679		b_transition_for_csp(ChOpName,_CSPAction,ChArgs,OpArgs,BState,OpName,Operation,NewB,TransInfo) :-
680	?	build_up_b_operation_for_csp(ChOpName,OpArgs,Operation),
681		!,
682		OpName = ChOpName,
683		%% print_message(trying_b_trans(Operation,ChArgs,OpArgs)), %%
684		(get_preference(operation_reuse_setting,false)
685		-> generate_b_operationargs_from_csp(ChArgs,OpArgs),
686	?	b_trans(BState,OpName,Operation,NewB,TransInfo)
687		;
688		% compute B transition without parameters so that we can cache
689	?	b_trans(BState,OpName,Operation,NewB,TransInfo),
690		% and unify afterwards
691		generate_b_operationargs_from_csp(ChArgs,OpArgs)
692		).
693		%%, print_message(csp_btrans(Operation)), %%.
694		b_transition_for_csp(ChOpName,_CSPAction,ChArgs,OpArgs,BState,OpName,Operation,NewB,TransInfo) :-
695		OpName = ChOpName,
696		(b_is_variable(ChOpName) ; b_is_constant(ChOpName)),
697		%% print(probing(ChOpName)),nl,
698		expand_const_and_vars_to_full_store(BState,FBState),
699		try_lookup_value_in_store_and_global_sets(ChOpName,FBState,IdValue),
700		!,
701		remove_infos_from_prepared_state(BState,NewB),
702		TransInfo=[],
703		/* interpret as probing operation: get value of var,cst,SET */
704		generate_b_operationargs_from_csp(ChArgs,OpArgs),
705		(OpArgs=[SingleVal]
706		-> SingleVal = IdValue, Operation='-->'(ChOpName,[IdValue])
707		; OpArgs=[Val1,Val2],
708	?	tuple_of(Val1,Val2,IdValue), /* from bsets_clp, use exact_element_of ??? */
709		OpCall =.. [ChOpName,Val1],
710		Operation='-->'(OpCall,[Val2])
711		).
712		b_transition_for_csp(_ChOpName,CSPAction,_ChArgs,_OpArgs,BState,OpName,Operation,NewB,TransInfo) :-
713		OpName = '$CSP', % all CSP events grouped together
714		remove_infos_from_prepared_state(BState,NewB),
715		TransInfo=[],
716		/* no B operation of the name; could be tau or tick or extra comm channel */
717		%Op1 =.. [ChOpName|OpArgs],
718		Operation = CSPAction. % removed csp(.) wrapper [for LTL model checker]
719
720		hide_csp_event(CSPAction,_,EventVisibleToUser) :-
721		symbol('HIDE_CSPB',_,Span,_),!, % if there is a HIDE_CSPB definition then we do MAIN [{| HIDE_CSPB |}] B_MACHINE \ {| HIDE_CSPB |}
722		haskell_csp:evaluate_argument(val_of('HIDE_CSPB',Span),EvCList),
723		% print(hide(EvCList,CSPAction)),nl,
724		haskell_csp:expand_channel_pattern_expression(EvCList,ECList,no_loc_info_available),
725	?	haskell_csp:cspm_hide_action(CSPAction,omega,ECList, Span, EventVisibleToUser,_).
726		hide_csp_event(_CSPAction,Operation,EventVisibleToUser) :-
727		% get_preference(csp_event_visible_to_user,true) -> EventVisibleToUser = CSPAction
728		EventVisibleToUser = Operation.
729
730		build_up_b_operation_for_csp(OpName,OpArgs,Operation) :- %print(csp(OpName,OpArgs,Operation)),nl,
731		nonvar(OpName),
732		b_get_machine_operation(OpName,Res,Params,_), %print(get_machine_op(OpName,Res,Params)),nl,
733	?	specfile:generate_args(OpArgs,Params,Res, BArgs,BResults,OpName), %print(gen_args(BArgs,BResults)),nl,
734		% TO DO: either also extract types from Params, Res or better write a static checker that tests that the B operation and CSP channel types are compatible
735		safe_univ(Op1,[OpName|BArgs]), %print(op1(Op1)),nl,
736		(BResults = [] -> Operation = Op1 ; Operation = '-->'(Op1,BResults)).
737
738		:- use_module(bmachine,[b_get_machine_operation_for_animation/6]).
739		build_up_b_real_operation(OpName,Operation) :-
740		b_get_machine_operation_for_animation(OpName,Res,Params,_,_,true), %true==TopLevel
741		length(Params,Len), length(OpArgs,Len),
742		length(Res,RLen), length(BResults,RLen),
743		safe_univ(Op1,[OpName|OpArgs]),
744		(BResults = [] -> Operation = Op1 ; Operation = '-->'(Op1,BResults)).
745
746		generate_args([],[],Res,[],BRes,_) :- length(Res,L), length(BRes,L).
747		generate_args([],[_Param|T],Res,[_|TA],BRes,OpName) :-
748	?	generate_args([],T,Res,TA,BRes,OpName).
749		generate_args([CSPArg|TC],[Param|T],Res,[CSPArg|TA],BRes,OpName) :- check_type_for_id(CSPArg,Param,OpName),
750	?	generate_args(TC,T,Res,TA,BRes,OpName).
751		generate_args([CSPArg|TC],[],[ReturnParam|TRes],[],[CSPArg|TBRes],OpName) :-
752		check_type_for_id(CSPArg,ReturnParam,OpName),
753	?	generate_args(TC,[],TRes,[],TBRes,OpName).
754		generate_args([H|T],[],[],[],[],OpName) :-
755		add_error(specfile,'CSP provides extra arguments: ',OpName:[H|T]).
756
757		check_type_for_id(Val,TID,OpName) :- get_texpr_type(TID,Type),
758		check_type(Type,Val,OpName:TID).
759
760		:- block check_type(?,-,?).
761		check_type(boolean,pred_true,_) :- !.
762		check_type(boolean,pred_false,_) :- !.
763		check_type(integer,int(_),_) :- !.
764		check_type(string,string(_),_) :- !.
765		check_type(global(GS),fd(_,GS),_) :- !.
766		check_type(couple(A,B),(VA,VB),OID) :- !, check_type(A,VA,OID), check_type(B,VB,OID).
767		check_type(set(_T),[],_) :- !.
768		check_type(set(_T),closure(_,_,_),_) :- !. % TO DO: check type signature of closure
769		check_type(set(T),[H|_],OID) :- !, check_type(T,H,OID).
770		check_type(set(T),avl_set((node(Y,_,_,_L,_R))),OID) :- !, check_type(T,Y,OID).
771		check_type(seq(T),V,OID) :- !, check_type(set(couple(integer,T)),V,OID).
772		% TO DO: record, freetype ; but do not appear in translation from CSP to B yet
773		check_type(Type,Value,OpName:TID) :-
774		def_get_texpr_id(TID,ID),
775		add_error(check_type_for_id,'Illegal CSP value for argument: ',OpName:ID:type(Type):value(Value)),
776		fail.
777
778		get_operation_internal_name(Op,Name) :- var(Op),!,
779		add_error(get_operation_internal_name,'Variable Transition: ',Op), Name=Op.
780		get_operation_internal_name('$initialise_machine',N) :- !, N='$initialise_machine'.
781		get_operation_internal_name('$setup_constants',N) :- !, N='$setup_constants'.
782		get_operation_internal_name('$partial_setup_constants',N) :- !, N='$partial_setup_constants'.
783		get_operation_internal_name(Op,Name) :- get_operation_name(Op,Name).
784
785		is_setup_constants_internal_name('$setup_constants').
786		is_setup_constants_internal_name('$partial_setup_constants').
787
788		% tool to get the basic operation/channel/event name of a transition:
789		get_operation_name(Op,Name) :- var(Op),!, add_error(get_operation_name,'Variable Transition: ',Op), Name=Op.
790		get_operation_name('-->'(F,_),N) :- !, functor(F,N,_).
791		%get_operation_name(io([Action|_],proc(_Nr,_PROC),_SPAN),F) :-
792		% animation_mode(promela),!,functor(Action,F,_).
793		get_operation_name(io(_V,Ch,_SPAN),N) :- csp_mode,!, functor(Ch,N,_).
794		get_operation_name(FullOperation,Name) :- functor(FullOperation,Functor,_),
795		translate_operation_name(Functor,Name).
796
797		get_operation_arguments(Op,Args) :- var(Op),!, add_error(get_operation_arguments,'Variable Transition: ',Op), Args=[].
798		get_operation_arguments('-->'(F,_ReturnValues),Args) :- !, F =.. [_|Args].
799		%get_operation_arguments(io([_Action|V],proc(_Nr,_PROC),_SPAN),Args) :-
800		% animation_mode(promela),!,Args=V.
801		get_operation_arguments(io(V,_Ch,_SPAN),Args) :- csp_mode,!, Args = V.
802		get_operation_arguments(FullOperation,Args) :- FullOperation =.. [_|Args].
803
804		get_operation_return_values_and_arguments('-->'(F,ReturnValues),ReturnValues,Args) :- !,
805		F =.. [_|Args].
806		get_operation_return_values_and_arguments(Op,[],Args) :- get_operation_arguments(Op,Args).
807
808		translate_operation_name(Var,T) :- var(Var),!,T='_?Operation?_'.
809		translate_operation_name('$initialise_machine',T) :- !,T='INITIALISATION'.
810		translate_operation_name('$setup_constants',T) :- !,T='SETUP_CONSTANTS'.
811		translate_operation_name('$partial_setup_constants',T) :- !,T='PARTIAL_SETUP_CONSTANTS'.
812		%translate_operation_name(InternalName,Res) :- !, Res=InternalName.
813		translate_operation_name(X,X).
814
815		:- use_module(bmachine,[b_get_operation_description/2]).
816		% get a textual description of a transition, based on description pragma
817		get_operation_description(OpTerm,Desc) :- b_or_z_mode,
818		get_operation_name(OpTerm,OpName),
819		b_get_operation_description(OpName,Desc).
820		% in future we could possible use operation parameter values to adapt description
821
822		:- use_module(state_space,[transition/4,transition_info/2]).
823		get_operation_description_for_transition_id(StateId,TransitionId,Desc) :-
824		transition(StateId,OpTerm,TransitionId,NextId), !,
825		(xtl_mode % TODO: allow other modes?
826		-> transition_info(TransitionId,description(Desc))
827		; get_operation_description_for_transition(StateId,OpTerm,NextId,Desc)
828		).
829		get_operation_description_for_transition_id(StateId,TransitionId,_) :-
830		format('No transition from state ~w with id ~w!~n', [StateId,TransitionId]),
831		fail.
832
833		:- use_module(probsrc(b_interpreter),[b_compute_explicit_epression_no_wf/6]).
834		:- use_module(probsrc(bmachine),[get_operation_description_template_expr/2]).
835		% get a description for operation from a given state; to do: we could provide destination state
836		get_operation_description_for_transition(StateId,OpTerm,NextId,Desc) :- xtl_mode, !,
837		transition(StateId,OpTerm,TransitionId,NextId),
838		transition_info(TransitionId,description(Desc)).
839		get_operation_description_for_transition(StateId,OpTerm,NextId,Desc) :- b_or_z_mode,
840		get_operation_internal_name(OpTerm,OpName),
841		get_operation_description_template_expr(OpName,TemplateStringExpr),
842		visited_expression(NextId,State),
843		state_for_op(OpName,State,BState1),
844		visited_expression(StateId,BeforeState),
845		( no_before_state(OpName) -> BState=BState1
846		; state_for_op(OpName,BeforeState,BState0)
847		-> extract_variables_from_state_as_primed(BState0,PrimedBefore),
848		append(PrimedBefore,BState1,BState)
849		; add_warning(specfile,'Could not get initialised before state for: ',StateId),
850		BState = BState1
851		),
852		% TODO: use NextId and add StateId as $0 vars
853		% maplist(create_primed_binding,InVariablesState,PrimedVars),
854		% append(PrimedVars,Out,PredState),
855		!,
856		get_local_state_for_operation_transition(OpName,OpTerm,LocalState),
857		%write(local_state(OpName,OpTerm,LocalState)),nl,
858		% TODO: process errors better
859		if(b_compute_explicit_epression_no_wf(TemplateStringExpr,LocalState,BState,string(SD),
860		operation_description(OpName),0),
861		Desc=SD,
862		(get_operation_description(OpTerm,D), ajoin(['Error evaluating template: ',D],Desc))
863		).
864		get_operation_description_for_transition(_StateId,OpTerm,_NextStateId,Desc) :-
865		get_operation_description(OpTerm,Desc).
866
867		state_for_op('$setup_constants',State,BState) :- !,
868		state_corresponds_to_set_up_constants(State,BState).
869		state_for_op(_,State,BState) :-
870		state_corresponds_to_initialised_b_machine(State,BState).
871
872		no_before_state('$setup_constants').
873		no_before_state('$initialise_machine').
874
875		get_local_state_for_operation_transition(OpName,OperationTerm,LocalState) :-
876		get_local_states_for_operation_transition(OpName,OperationTerm,ParaStore,ResultStore),
877		append(ResultStore,ParaStore,LocalState).
878
879		% get local states for parameter values and result values extracted from a B operation transition term
880		get_local_states_for_operation_transition(OpName,OperationTerm,ParaStore,ResultStore) :- b_or_z_mode,!,
881		get_operation_return_values_and_arguments(OperationTerm,ReturnValues,ParaValues),
882	?	(b_get_machine_operation_for_animation(OpName,Results,Parameters,_Body,_OType,_TopLevel,OpPos)
883		-> true
884		; is_setup_constants_internal_name(OpName) -> Results=[], Parameters=[], OpPos=unknown
885		; add_error(specfile,'Unrecognized operation: ',OpName),
886		Results=[], Parameters=[], OpPos=unknown
887		),
888		def_get_texpr_ids(Parameters,OpParameterNames), % also includes virtual parameters (show_eventb_any_arguments)
889		(ParaValues=[]
890		-> ParaStore=[]
891		; (OpParameterNames=[], ParaValues=[_|_]
892		-> (get_preference(show_eventb_any_arguments,true)
893		-> add_message(specfile,'Ignoring additional parameters for:',OpName,OpPos)
894		; add_warning(specfile,'Ignoring additional parameters for:',OpName,OpPos)
895		),
896		ParaStore = []
897		; create_local_store_for_operation(OpParameterNames,ParaValues,OpName,ParaStore)
898		)
899		),
900		(ReturnValues=[]
901		-> ResultStore = []
902		; %b_get_machine_operation_result_names(OpName,OpResults),
903		def_get_texpr_ids(Results,OpResults),
904		create_local_store_for_operation(OpResults,ReturnValues,OpName,ResultStore)
905		).
906		get_local_states_for_operation_transition(OpName,OperationTerm,ParaStore,ResultStore) :- xtl_mode,
907		xtl_transition_parameters(OpName,ParaNames), !, % user-defined parameters found, otherwise use default params below
908		get_operation_return_values_and_arguments(OperationTerm,_ReturnValues,ParaValues), % ReturnValues should always be []
909		ResultStore = [],
910		maplist(gen_id_bind,ParaNames,ParaValues,ParaStore).
911		get_local_states_for_operation_transition(_OpName,OperationTerm,ParaStore,ResultStore) :- % not B mode or no user-defined params available in XTL mode
912		ResultStore = [],
913		get_operation_return_values_and_arguments(OperationTerm,ReturnValues,ParaValues),
914		ReturnValues = [], % should always succeed
915		gen_para_bind(ParaValues,1,ParaStore). % create [bind(para1,Val1),...]
916
917		gen_id_bind(ID,Val,bind(ID,Val)).
918
919		gen_para_bind([],_,[]).
920		gen_para_bind([H|T],Nr,[bind(ParaNr,H)|BT]) :- ajoin([para,Nr],ParaNr),
921		N1 is Nr+1,
922		gen_para_bind(T,N1,BT).
923
924		% create a store from parameter names and values:
925		create_local_store_for_operation([],[],_,Store) :- !, Store=[].
926		create_local_store_for_operation([Name|NT],[Val|VT],OpName,[bind(Name,Val)|StoreT]) :- !,
927		create_local_store_for_operation(NT,VT,OpName,StoreT).
928		create_local_store_for_operation([Name|NT],[],OpName,Store) :- !,
929		ajoin(['Missing values for operation ',OpName,':'],Msg),
930		add_error(specfile,Msg,[Name|NT]),
931		Store = [].
932		create_local_store_for_operation(_,V,OpName,Store) :-
933		ajoin(['Too many values for operation ',OpName,':'],Msg),
934		add_error(specfile,Msg,V),
935		Store = [].
936
937		:- use_module(library(between),[between/3]).
938
939		b_trans(State,OpName,Operation,NewState,PathInfo) :-
940	?	compute_operation_effect_max(State,OpName,Operation,NewState,PathInfo,_Max).
941
942		:- use_module(store,[store_updates_and_normalise/3]).
943
944		compute_operation_effect_max([],OpName,Operation,NewState,PathInfo,Max) :-
945	?	compute_operation_updates_on_expanded_store([],OpName,Operation,Updates,PathInfo,Max),
946		store_updates_and_normalise(Updates,[],NewState).
947		compute_operation_effect_max([H|T],OpName,Operation,NewState,PathInfo,Max) :-
948	?	compute_operation_updates_on_expanded_store([H|T],OpName,Operation,Updates,PathInfo,Max),
949		store_updates_and_normalise(Updates,[H|T],NewState).
950		compute_operation_effect_max(const_and_vars(ConstID,Vars),OpName,Operation,ResultingStore,PathInfo,Max) :-
951		prepare_state_for_specfile_trans(const_and_vars(ConstID,Vars),unknown,R),
952		%print(expanded_const_and_vars(ConstID)),nl,
953		compute_operation_effect_max(R,OpName,Operation,ResultingStore,PathInfo,Max).
954		compute_operation_effect_max(expanded_const_and_vars(ID,Vars,FullStore,Infos),OpName,Operation,NewState,PathInfo,Max) :-
955	?	compute_operation_updates_on_expanded_store(expanded_const_and_vars(ID,Vars,FullStore,Infos),
956		OpName,Operation,Updates,PathInfo,Max),
957		NewState = const_and_vars(ID,NewVars),
958		store_updates_and_normalise(Updates,Vars,NewVars).
959		compute_operation_effect_max(expanded_vars(FullStore,Infos),OpName,Operation,NewState,PathInfo,Max) :-
960	?	compute_operation_updates_on_expanded_store(expanded_vars(FullStore,Infos),
961		OpName,Operation,Updates,PathInfo,Max),
962		store_updates_and_normalise(Updates,FullStore,NewState).
963
964		compute_operation_effect_max(concrete_constants(ConstantsStore),'$initialise_machine',OpInit,ResultingStore,PathInfo,Max) :-
965		get_max_enablings_for_init(Max,'$initialise_machine',MaxForCall),
966	?	succeed_max_call_id('$initialise_machine',
967		b_interpreter:b_initialise_machine(ConstantsStore,InitialVars,InitialStore,PathInfo),MaxForCall),
968		create_initialisation_operation(InitialVars,OpInit),
969		(\+ preferences:preference(symmetry_mode,flood), /* TO DO : improve permutation to allow using const_and_vars optimisation */
970	?	visited_expression(ConstID,concrete_constants(ConstantsStore))
971		-> ResultingStore = const_and_vars(ConstID,InitialVars) /* avoid storing constant values again */
972		; ResultingStore = InitialStore).
973		compute_operation_effect_max(root,'$setup_constants',OpSetup,concrete_constants(FilteredConstantsStore),[],Max) :-
974		b_machine_has_constants_or_properties,
975		get_max_enablings_for_init(Max,'$setup_constants',MaxForCall),
976	?	compute_constants(ConstantsStore,MaxForCall,Complete),
977		create_setup_constants_operation(ConstantsStore,Complete,OpSetup),
978		%%print_message('FOUND_CONSTANTS'(OpName)),
979		(get_preference(filter_unused_constants,true) % possibly disable if VisB or Custom Graph Definitions exist
980		-> exclude(unused_binding,ConstantsStore,FilteredConstantsStore)
981		; FilteredConstantsStore=ConstantsStore).
982		compute_operation_effect_max(root,'$initialise_machine',OpInit,InitialStore,PathInfo,Max) :-
983		\+ b_machine_has_constants_or_properties,
984		get_max_enablings_for_init(Max,'$initialise_machine',MaxForCall),
985		empty_state(EmptyState),
986	?	succeed_max_call_id('$initialise_machine',
987		b_interpreter:b_initialise_machine(EmptyState,InitialVars,InitialStore,PathInfo),MaxForCall),
988		create_initialisation_operation(InitialVars,OpInit).
989
990
991		unused_binding(bind(C,_)) :- bmachine:b_is_unused_constant(C).
992
993		compute_constants(ConstantsStore,_Max,C) :-
994		% check if values have been computed and stored into a file before -- if yes, use them
995		load_constants(Stores,MaxReached),!,
996		C = complete_properties, % TODO: check that only complete properties stored or that we store this info
997	?	choose_loaded_solution(Stores,ConstantsStore,MaxReached).
998		compute_constants(ConstantsStore,Max,Complete) :-
999		% print('Searching for valid CONSTANTS'),nl,!,
1000	?	succeed_max_call_id('$setup_constants',b_interpreter:b_set_up_concrete_constants(ConstantsStore,Complete),Max).
1001
1002		choose_loaded_solution(Stores,ConstantsStore,_MaxReached) :-
1003	?	member(ConstantsStore,Stores).
1004		choose_loaded_solution(_Stores,_ConstantsStore,true) :-
1005		% provoke the setting of the "maximum reached flag"
1006		succeed_max_call_id('$setup_constants',member(_,_),1),fail.
1007
1008		expand_const_and_vars_to_full_store(root,R) :- !,R=[].
1009		expand_const_and_vars_to_full_store(concrete_constants(ConstantsStore),FullStore) :- !,
1010		ConstantsStore = FullStore.
1011		expand_const_and_vars_to_full_store(const_and_vars(ConstID,Vars),FullStore) :- !,
1012		expand_const_and_vars(ConstID,Vars,FullStore).
1013		expand_const_and_vars_to_full_store(expanded_const_and_vars(_ConstID,_Vars,ExpStore,_),FullStore) :- !,
1014		FullStore = ExpStore.
1015		expand_const_and_vars_to_full_store(expanded_vars(ExpStore,_),FullStore) :- !,
1016		FullStore = ExpStore.
1017		expand_const_and_vars_to_full_store(csp_and_b(_,BState),FullStore) :- !,
1018		expand_const_and_vars_to_full_store(BState,FullStore).
1019		expand_const_and_vars_to_full_store(R,R).
1020
1021		expand_const_and_vars(ConstID,Vars,FullStore) :-
1022		visited_expression(ConstID,concrete_constants(ConstantsStore)),
1023		%% This can take a while if the Constants are big !
1024		% print('exp: '),tools_printing:print_term_summary(ConstantsStore),nl,
1025		append(Vars,ConstantsStore,FullStore). % used to be Constants first, now consistent with b_initialise_machine2,
1026		% b_initialise_machine2 puts constants at end to make sharing of complete tail-list easier for successor states
1027
1028		expand_to_constants_and_variables(root,[],[]).
1029		expand_to_constants_and_variables(concrete_constants(ConstStore),ConstStore,[]).
1030		expand_to_constants_and_variables(const_and_vars(ConstID,VarStore),ConstStore,VarStore) :-
1031		visited_expression(ConstID,concrete_constants(ConstStore)).
1032		expand_to_constants_and_variables([],[],[]).
1033		expand_to_constants_and_variables([H|T],[],[H|T]).
1034		expand_to_constants_and_variables(csp_and_b(_,BState),ConstStore,VarStore) :-
1035		expand_to_constants_and_variables(BState,ConstStore,VarStore).
1036
1037		:- use_module(extrasrc(b_operation_cache),[compute_operation_on_expanded_store_cache/6]).
1038
1039		% compute operation effect on a store where all constants have been put into the environment
1040		compute_operation_updates_on_expanded_store(InState,OpName,Operation,NewState,PathInfo,Max) :-
1041		get_preference(operation_reuse_setting,V), V \= false,
1042		b_or_z_mode, % now works with CSP || B
1043		%\+ animation_minor_mode(eventb), % projection used to confuse Event-B interpreter, see test 2138
1044		!,
1045		get_max_enablings_per_operation(Max,OpName,maxNrOfEnablingsPerOperation,MaxForCall),
1046	?	compute_operation_on_expanded_store_cache(OpName,Operation,InState,NewState,PathInfo,MaxForCall).
1047		compute_operation_updates_on_expanded_store(Store,OpName,Operation,Updates,PathInfo,Max) :-
1048		extract_full_store(Store,FullStore),!,
1049	?	compute_operation_on_expanded_store2(FullStore,OpName,Operation,Updates,PathInfo,Max).
1050		compute_operation_updates_on_expanded_store(InState,OpName,Operation,Updates,PathInfo,Max) :-
1051	?	compute_operation_on_expanded_store2(InState,OpName,Operation,Updates,PathInfo,Max).
1052
1053		compute_operation_on_expanded_store2(InState,OpName,Operation,Updates,PathInfo,Max) :-
1054		get_max_enablings_per_operation(Max,OpName,maxNrOfEnablingsPerOperation,MaxForCall),
1055	?	succeed_max_call_id(OpName,
1056		b_interpreter:b_execute_top_level_operation_update(OpName,Operation,InState,Updates,PathInfo),
1057		MaxForCall).
1058
1059		extract_full_store(expanded_const_and_vars(_,_,FS,_),Res) :- !, Res=FS.
1060		extract_full_store(expanded_vars(FS,_),Res) :- !, Res=FS.
1061
1062		create_initialisation_operation(_InitialVars,'$initialise_machine').
1063
1064		create_setup_constants_operation(_ConstantVars,complete_properties,R) :- !, R='$setup_constants'.
1065		create_setup_constants_operation(_ConstantVars,_,'$partial_setup_constants').
1066
1067		:- use_module(bmachine,[b_get_machine_operation_max/2]). % MAX_OPERATIONS_... DEFINITIONS
1068		get_max_enablings_per_operation_aux(OpName,RMax,_,RandomisedRestart) :-
1069		% TODO: decompose prefixed operation names with . write(get_mach_op_max(OpName)),nl,
1070		b_get_machine_operation_max(OpName,Max),
1071		!,
1072		(Max<0 -> RMax is -Max, RandomisedRestart=true ; RMax=Max, RandomisedRestart=false).
1073		get_max_enablings_per_operation_aux(_OpName,Max,DefaultPref,false) :-
1074		preferences:preference(DefaultPref,Max).
1075
1076		max_operations_zero_for_operation(OpName) :-
1077		b_or_z_mode,
1078		b_top_level_operation(OpName),
1079		(b_get_machine_operation_max(OpName,0) -> true
1080		; get_preference(maxNrOfEnablingsPerOperation,0)).
1081
1082		max_operations_zero_for_setup_constants :-
1083		b_or_z_mode,
1084		(b_get_machine_operation_max('$setup_constants',0) -> true
1085		; get_preference(maxNrOfInitialisations,0)).
1086		max_operations_zero_for_initialisation :-
1087		b_or_z_mode,
1088		(b_get_machine_operation_max('$initialise_machine',0) -> true
1089		; get_preference(maxNrOfInitialisations,0)).
1090
1091		get_max_enablings_per_operation(Max,OpName,DefaultPref,MaxForCall) :-
1092		(var(Max) -> get_max_enablings_per_operation_aux(OpName,Max,DefaultPref,RandomisedRestart)
1093		; RandomisedRestart=false),
1094		(RandomisedRestart=true,
1095		get_preference(randomise_enumeration_order,true)
1096		-> % we succeed Max times with the value 1, thus forcing a randomised restart
1097		MaxForCall=1, between(1,Max,Retry), format('Randomised Restart ~w for ~w~n',[Retry,OpName])
1098		; % we succeed once with the value Max
1099		MaxForCall is Max).
1100
1101		get_max_enablings_for_init(Max,OpName,MaxForCall) :-
1102		translate_operation_name(OpName,IOp),
1103		get_max_enablings_per_operation(Max,IOp,maxNrOfInitialisations,MaxForCall).
1104
1105		get_specific_max_operations_for_operation(OpName,MaxOp) :-
1106		b_or_z_mode,
1107		b_get_machine_operation_max(OpName,MaxOp).
1108
1109		:- use_module(bmachine,[b_get_machine_operation_time_out/2]).
1110		get_specific_time_out_for_operation(OpName,TimeOut) :-
1111		b_or_z_mode,
1112		b_get_machine_operation_time_out(OpName,TimeOut).
1113
1114		/* PROPERTIES */
1115
1116		property(const_and_vars(ConstID,Vars),Property) :- b_or_z_mode,
1117		expand_const_and_vars(ConstID,Vars,FullStore),!,
1118	?	property(FullStore,Property).
1119		property(csp_and_b(CSPState,BState),Property) :- animation_mode(csp_and_b),!,
1120		%% print(checking_csp_and_b(CSPState)),nl,
1121		expand_const_and_vars_to_full_store(BState,FBState),
1122		(xtl_interface:cspm_property(CSPState,Property) ;
1123		b_property(FBState,Property)).
1124		property(State,Property) :- animation_mode(AM),
1125	?	(AM = b -> b_property(State,Property)
1126	?	; AM=xtl -> xtl_interface:xtl_property(State,Property)
1127		; AM=cspm -> xtl_interface:cspm_property(State,Property)
1128		; AM=csp_and_b -> b_property(State,Property) % State should be root
1129		).
1130
1131		%b_property(const_and_vars(ConstID,Vars),Prop) :- !,
1132		% expand_const_and_vars(ConstID,Vars,FullStore),
1133		% b_property(FullStore,Prop).
1134	?	b_property(root,Prop) :- !, b_preference_par(PARA,Op,VAL), Prop=.. [Op,PARA,VAL].
1135		b_property([H|T],non_ground(Var)) :- debug:debug_mode(on),
1136		member(bind(Var,Val),[H|T]),\+(ground(Val)).
1137	?	b_property([H|T],Prop) :- elementary_prop([H|T],Prop).
1138		b_property([],Prop) :- elementary_prop([],Prop).
1139		b_property(concrete_constants(DB),Prop) :- elementary_prop(DB,Prop).
1140
1141
1142
1143		:- use_module(preferences).
1144		:- use_module(b_global_sets,[b_global_set/1, b_fd_card/2,inferred_minimum_global_set_cardinality/2,
1145		inferred_maximum_global_set_cardinality/2, unfixed_deferred_set/1]).
1146
1147		% preference values shown as properties of the root node
1148		b_preference_par('MAXINT','=',MaxInt) :- get_preference(maxint,MaxInt).
1149		b_preference_par('MININT','=',MinInt) :- get_preference(minint,MinInt).
1150		b_preference_par(card(GlobalSet),Op,Card) :-
1151		b_global_set(GlobalSet),
1152		b_fd_card(GlobalSet,RCard),
1153		% provide feedback if unfixed_deferred_set
1154		(inferred_maximum_global_set_cardinality(GlobalSet,MaxCard),
1155		(inferred_minimum_global_set_cardinality(GlobalSet,MinCard) -> true ; MinCard=1),
1156		MinCard \= MaxCard,
1157		Op = ':', Card = '..'(MinCard,MaxCard)
1158
1159		;
1160
1161		inferred_minimum_global_set_cardinality(GlobalSet,MinCard),
1162		\+ (inferred_maximum_global_set_cardinality(GlobalSet,_)),
1163		Op='>=',Card=MinCard % show minimum cardinality info
1164
1165		;
1166
1167		Op= '=', (unfixed_deferred_set(GlobalSet)
1168		-> ajoin([RCard,' (assumed for deferred set)'],Card) ; Card=RCard)
1169		).
1170
1171		/* --------------------------------------------------------- */
1172
1173
1174		elementary_prop(DB,Prop) :-
1175	?	member(bind(Var,Val),DB), %print(var_prop(Var)),nl_time,
1176	?	elementary_prop3(Val,Var,Prop).
1177
1178		:- use_module(custom_explicit_sets,[is_avl_relation/1,is_avl_partial_function/1,get_first_avl_elements/4, avl_approximate_size/3]).
1179		elementary_prop3(Val,Var,Prop) :- var(Val),!, Prop = '='(Var,'_VAR_').
1180		elementary_prop3(avl_set(Avl),Var,Prop) :- !,
1181		(show_avl_set(Avl) % \+ custom_explicit_sets:is_avl_sequence(Avl))
1182	?	-> elementary_fun_prop(avl_set(Avl),Var,Prop)
1183		; elementary_var_prop(avl_set(Avl),Var,Prop)).
1184		elementary_prop3([H|T],Var,Prop) :- H=(_,_),
1185		get_preference(show_function_tuples_in_property,true),!,
1186		elementary_fun_prop([H|T],Var,Prop).
1187		elementary_prop3(Val,Var,Prop) :- elementary_var_prop(Val,Var,Prop).
1188
1189		show_avl_set(AVL) :- get_preference(show_function_tuples_in_property,true),
1190		is_avl_relation(AVL),
1191		avl_approximate_size(AVL,0,Size), Size < 257, % only the first 30 will be shown by get_relation_element anyway
1192		is_avl_partial_function(AVL).
1193
1194
1195		:- use_module(bmachine,[b_is_variable/2]).
1196		elementary_var_prop(Val,Var,Prop) :-
1197		% TODO: use translate:translate_bvalue_for_expression/3
1198		animation_minor_mode(tla),!,
1199		( identifier_has_tla_type(Var,TlaType) ->
1200		translate_bvalue_with_tlatype(Val,TlaType,Text)
1201		;
1202		translate_bvalue(Val,Text)),
1203		Prop = '='(Var,Text).
1204		elementary_var_prop(Val,Var,Prop) :-
1205	?	(var_cst_type(Var,Type)
1206		-> translate_bvalue_with_type_and_limit(Val,Type,320,Text)
1207		; translate_bvalue_with_type_and_limit(Val,any,320,Text)), % translate_properties_with_limit uses 320 Limit
1208		Prop = '='(Var,Text).
1209
1210		identifier_has_tla_type(Id,Type) :-
1211		get_texpr_id(TId,Id),
1212		(b_get_machine_constants(Ids)
1213		;b_get_machine_variables(Ids)),
1214		member(TId,Ids),!,
1215		get_texpr_info(TId,Infos),
1216		memberchk(tla_type(Type),Infos).
1217		% to do: use b_is_variable + translate_bvalue_with_type
1218		elementary_fun_prop(Val,Var,Prop) :-
1219		simple(Prop), % will only succeed if Prop is var or atom; translate_bexpression will raise error if Prop is compound
1220		nonvar(Val),
1221	?	(var_cst_type(Var,Type),dom_range_type(Type,Dom,Ran) -> true ; Type=any,Dom=any, Ran=any),
1222	?	get_relation_element(Val,X,Y), % Show value in form: Var(X) = Y
1223		create_texpr(identifier(Var),Type,[],Fun),
1224		create_value(X,Dom,Arg),
1225		create_texpr(function(Fun,Arg),Ran,[],Lhs),
1226		create_value(Y,Ran,Rhs),
1227		create_texpr(equal(Lhs,Rhs),pred,[],Expr),
1228		translate_bexpression_with_limit(Expr,80,Prop).
1229
1230		var_cst_type(Name,Type) :- (b_is_variable(Name,Type) ; b_is_constant(Name,Type)).
1231		dom_range_type(seq(R),integer,R).
1232		dom_range_type(set(couple(D,R)),D,R).
1233
1234		get_relation_element(avl_set(A),X,Y) :- custom_explicit_sets:is_avl_relation(A),
1235		!, %preferences:preference(expand_avl_upto,Limit),
1236		Limit=30, % reduced limit, as now we can inspect with evaluation view
1237		get_first_avl_elements(A,Limit,Els,CutOff),
1238		(member((X,Y),Els), X\=term(_)
1239		;
1240		CutOff=not_all, X='...', Y='...').
1241		get_relation_element(Value,X,Y) :-
1242		member((X,Y),Value). /* otherwise we have a record structure */
1243
1244		create_value('...',_,R) :- !, R = b(string('...'),string,[]).
1245		create_value(X,T,R) :-
1246		create_texpr(value(X),T,[],R).
1247
1248
1249		:- use_module(bmachine,[b_show_machine_representation/4]).
1250		:- use_module(probcspsrc(haskell_csp_analyzer),[get_internal_csp_representation/1]).
1251		get_internal_representation(X) :- get_internal_representation(X,true,false,none).
1252		get_internal_representation(X,AdditionalInfo,UnsetMinorMode,Typing) :- animation_mode(AM),
1253		get_internal_aux(AM,X,AdditionalInfo,UnsetMinorMode,Typing).
1254		get_internal_aux(b,X,AdditionalInfo,UnsetMinorMode,Typing) :- !,
1255		b_show_machine_representation(X,AdditionalInfo,UnsetMinorMode,Typing).
1256		% UnsetMinorMode=true means we try and generate classical B syntax
1257		get_internal_aux(cspm,X,_,_,_) :- !, get_internal_csp_representation(X).
1258		get_internal_aux(csp_and_b,Res,AdditionalInfo,UnsetMinorMode,Typing) :- !,
1259		append("CSP||B - B Part only",X,Res),
1260		b_show_machine_representation(X,AdditionalInfo,UnsetMinorMode,Typing).
1261		get_internal_aux(_,X,_,_,_) :- X="Internal representation only available in B or CSP mode".
1262
1263
1264		:- use_module(probcspsrc(haskell_csp),[channel/2]).
1265		:- use_module(bmachine,[b_top_level_operation/1, b_top_level_feasible_operation/1]).
1266		get_possible_event(OpName) :- b_or_z_mode,
1267		%b_is_operation_name(OpName).
1268	?	b_top_level_operation(OpName).
1269		get_possible_event(Channel) :- csp_mode,
1270	?	channel(Channel,_).
1271		% what about csp_and_b mode ?
1272
1273		get_feasible_event(OpName) :- b_or_z_mode,
1274		%b_is_operation_name(OpName).
1275	?	b_top_level_feasible_operation(OpName).
1276		get_feasible_event(Channel) :- csp_mode,
1277	?	channel(Channel,_).
1278
1279
1280		get_possible_language_specific_top_level_event(OpName,ResultNames,ParameterNames) :-
1281		b_or_z_mode,!,
1282		get_possible_b_top_level_event(OpName,ResultNames,ParameterNames).
1283		get_possible_language_specific_top_level_event(TransName,[],ParameterNames) :- xtl_mode, !,
1284		xtl_transition_parameters(TransName,ParameterNames).
1285		get_possible_language_specific_top_level_event(Channel,unknown,unknown) :- csp_mode,
1286		channel(Channel,_).
1287
1288		get_possible_b_top_level_event('$setup_constants',[],Ids) :-
1289		b_machine_has_constants_or_properties,
1290		b_get_machine_constants(TIds), maplist(get_texpr_id,TIds,Ids).
1291		get_possible_b_top_level_event('$initialise_machine',[],Ids) :-
1292		b_get_machine_variables(TIds), maplist(get_texpr_id,TIds,Ids).
1293		get_possible_b_top_level_event(OpName,ResultNames,ParameterNames) :-
1294		b_top_level_operation(OpName),
1295		%b_get_machine_operation(OpName,Results,RealParameters,_RealBody,_OType,_OpPos),
1296		b_get_machine_operation_for_animation(OpName,Results,AllParameters,_RealBody,_OType,_TL),
1297		maplist(get_texpr_id,Results,ResultNames),
1298		maplist(get_texpr_id,AllParameters,ParameterNames).
1299
1300		% obtain a textual description of specification category names
1301		get_specification_description(Category,Name) :-
1302		animation_mode(Mode),
1303		(animation_minor_mode(Minor) -> true ; Minor = none), % there could be several minor modes !
1304	?	(get_specific_description(Mode,Minor,Category,N) -> Name=N
1305		; get_default_description(Category,N) -> Name = N
1306		; add_error(get_specification_description,'Unknown category: ',Category),
1307		Name=Category).
1308
1309		get_specific_description(cspm,_,C,N) :- get_csp_description(C,N).
1310		get_specific_description(b,eventb,C,N) :- get_eventb_description(C,N).
1311		get_specific_description(b,tla,C,N) :- get_tla_description(C,N).
1312		get_specific_description(b,alloy,C,N) :- get_alloy_description(C,N).
1313
1314		get_csp_description(operations,'CHANNELS').
1315		get_csp_description(operation,'CHANNEL').
1316		get_csp_description(assertions,'CSP_ASSERTIONS').
1317		get_csp_description(machine,'CSP_SPECIFICATION').
1318		get_csp_description(operations_lc,'events').
1319
1320		get_tla_description(properties,'ASSUME').
1321		get_tla_description(machine,'MODULE').
1322		get_tla_description(operation,'ACTION'). % no key word
1323		get_tla_description(operations,'ACTIONS'). % no key word
1324		get_tla_description(operations_lc,'actions').
1325
1326		get_eventb_description(properties,'AXIOMS').
1327		get_eventb_description(assertions,'THEOREMS').
1328		get_eventb_description(operations,'EVENTS').
1329		get_eventb_description(operation,'EVENT').
1330		get_eventb_description(operations_lc,'events').
1331		get_eventb_description(machine,'MODEL').
1332
1333		get_alloy_description(machine,'MODULE').
1334		get_alloy_description(sets,'SIGNATURES'). % abstract
1335		get_alloy_description(operations,'RUNS').
1336		get_alloy_description(operation,'RUN').
1337
1338		get_default_description(constraints,'CONSTRAINTS').
1339		get_default_description(properties,'PROPERTIES').
1340		get_default_description(assertions,'ASSERTIONS').
1341		get_default_description(invariant,'INVARIANT').
1342		get_default_description(invariants,'INVARIANTS').
1343		get_default_description(operations,'OPERATIONS').
1344		get_default_description(operation,'OPERATION').
1345		get_default_description(operations_lc,'operations').
1346		get_default_description(machine,'MACHINE').
1347		get_default_description(constants,'CONSTANTS').
1348		get_default_description(variables,'VARIABLES').
1349		get_default_description(initialisation,'INITIALISATION').
1350		get_default_description(sets,'SETS').
1351		get_default_description(goal,'GOAL').
1352		get_default_description(definition,'DEFINITION').
1353		get_default_description(definitions,'DEFINITIONS').
1354		get_default_description(variants,'VARIANTS').