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