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