1		% Heinrich Heine Universitaet Duesseldorf
2		% (c) 2021-2026 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
3		% This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5		:- module(visb_visualiser,[load_visb_file/1,
6		load_visb_definitions_from_list_of_facts/2,
7		load_visb_definitions_from_term/2,
8		load_visb_file_if_necessary/1,
9		visb_file_is_loaded/1, visb_file_is_loaded/3,
10		visb_current_state_can_be_visualised/0, visb_state_can_be_visualised/1,
11		get_default_visb_file/2, extended_static_check_default_visb_file/0,
12		load_default_visb_file_if_necessary/0,
13		generate_visb_html_for_history/1, generate_visb_html_for_history/2,
14		generate_visb_html_for_history_with_vars/1,
15		generate_visb_html_for_history_with_source/1,
16		generate_visb_html_for_current_state/1, generate_visb_html_for_current_state/2,
17		generate_visb_html_codes_for_states/3,
18		generate_visb_html/3,
19		tcltk_get_visb_items/1, tcltk_get_visb_events/1,
20		tcltk_get_visb_objects/1, tcltk_get_visb_hovers/1,
21		get_visb_items/1, get_visb_attributes_for_state/2,
22		get_visb_click_events/1, get_visb_hovers/1,
23		perform_visb_click_event/4,
24		tcltk_perform_visb_click_event/1,
25		get_visb_default_svg_file_contents/1,
26		get_visb_svg_objects/1]).
27
28		:- use_module(probsrc(module_information),[module_info/2]).
29		:- module_info(group,visualization).
30		:- module_info(description,'This module provides VisB visualisation functionality.').
31
32		% special SVG object attributes treated by VisB
33		% title (creates hover tooltip; currently only works with objects created by VisB itself)
34		% id
35		% svg_class
36		% text
37		% hovers
38		% event, events
39		% predicate
40
41		:- meta_predicate process_repeat(-,-,-,2).
42
43		:- use_module(extrasrc(json_parser), [json_parse_file/3]).
44		:- use_module(library(lists)).
45		:- use_module(probsrc(error_manager)).
46		:- use_module(probsrc(preferences), [get_preference/2, reset_temporary_preference/2,
47		temporary_set_preference/3]).
48		:- use_module(probsrc(debug)).
49		:- use_module(probsrc(state_space), [visited_expression/2,
50		visited_state_corresponds_to_initialised_b_machine/1,
51		get_constants_id_for_state_id/2,
52		get_constants_state_id_for_id/2, set_context_state/2,
53		clear_context_state/0, transition/3, transition/4,
54		invariant_violated/1, invariant_not_yet_checked/1,
55		multiple_concrete_constants_exist/0, root_sufficiently_explored/0,
56		is_concrete_constants_state_id/1, current_state_id/1,
57		current_state_corresponds_to_setup_constants_b_machine/0,
58		visited_state_corresponds_to_setup_constants_b_machine/1,
59		time_out_for_node/3, get_action_trace_with_limit/2,
60		get_state_id_trace/1, max_reached_for_node/1]).
61		:- use_module(probsrc(translate), [translate_bvalue_to_codes/2,
62		translate_bvalue_to_codes_with_limit/3,
63		translate_bvalue_with_limit/3, pretty_type/2, set_unicode_mode/0,
64		unset_unicode_mode/0, translate_event_with_src_and_target_id/5]).
65		:- use_module(probsrc(specfile), [eventb_mode/0, xtl_mode/0,
66		state_corresponds_to_initialised_b_machine/2,
67		state_corresponds_to_fully_setup_b_machine/2,
68		state_corresponds_to_set_up_constants_only/2,
69		expand_to_constants_and_variables/3,
70		extract_variables_from_state/2, translate_operation_name/2,
71		classical_b_mode/0, currently_opened_file/1,
72		get_internal_representation/1,
73		get_operation_description_for_transition/4, b_or_z_mode/0, csp_with_bz_mode/0,
74		get_specification_description/2]).
75		:- use_module(probsrc(tools), [start_ms_timer/1, stop_ms_walltimer_with_msg/2, ajoin_with_sep/3,
76		split_list/4, html_escape_codes/2, read_string_from_file/2,
77		get_filename_extension/2, split_chars/3, safe_number_codes/2,
78		safe_atom_codes/2, b_string_escape_codes/2, gen_relative_path/3,
79		string_escape/2]).
80		:- use_module(probsrc(tools_io), [safe_open_file/4, with_open_stream_to_codes/4,
81		write_file_to_stream/2]).
82		:- use_module(probsrc(bmachine), [b_machine_name/1, b_get_definition_name_with_pos/4,
83		bmachine_is_precompiled/0, pre_expand_typing_scope/2,
84		determine_type_of_formula/2, determine_type_of_formula/3,
85		b_load_additional_definitions_file/1,
86		b_load_additional_definitions_from_list_of_facts/1,
87		b_load_additional_definitions_from_term/1,
88		set_additional_filename_as_parsing_default/3,
89		reset_filename_parsing_default/2,
90		b_sorted_b_definition_prefixed/4, b_get_typed_definition/3,
91		b_is_operation_name/1,
92		b_parse_machine_operation_pre_post_predicate/5,
93		b_get_machine_variables/1, b_get_machine_constants/1,
94		b_top_level_operation/1, b_get_machine_animation_expression/2,
95		b_get_operation_variant/3, b_nth1_non_ignored_invariant/3,
96		b_get_machine_operation_signature/2, b_get_machine_operation_max/2]).
97		:- use_module(probsrc(bsyntaxtree), [get_texpr_ids/2, get_texpr_pos/2, create_couple/2,
98		create_couple/3, replace_ids_by_exprs/4, create_equality/3,
99		get_texpr_type/2, find_identifier_uses/3,
100		conjunct_predicates/2, map_over_bexpr/2, get_texpr_id/2,
101		get_texpr_description/2, safe_create_texpr/3]).
102		:- use_module(probsrc(tools_lists), [include_maplist/3]).
103		:- use_module(probsrc(tools_matching), [get_all_svg_attributes/1, is_svg_attribute/1,
104		is_virtual_svg_attribute/1, is_svg_number_attribute/2,
105		is_svg_color_attribute/1, svg_attribute_default_value/2,
106		get_possible_fuzzy_matches_and_completions_msg/3,
107		get_all_svg_classes/1, is_svg_shape_class/1, is_html_tag/1,
108		is_html_attribute/1, dotshape2svg_class/2,
109		fix_svg_attribute/2, is_dot_attribute/1]).
110		:- use_module(visb_static_check, [static_check_dynamic_update_def_body/1,
111		static_check_attribute_value_expression/2,
112		check_svg_attribute_value/3]).
113		:- use_module(probsrc(eventhandling), [register_event_listener/3]).
114		:- use_module(probsrc(pref_definitions), [b_get_definition_string_from_spec/3]).
115		:- use_module(library(file_systems), [file_exists/1, file_property/3]).
116		:- use_module(probsrc(tools_strings), [ajoin/2, safe_name/2, atom_prefix/2,
117		is_simple_classical_b_identifier_codes/1,
118		number_codes_min_length/3, format_modified_info/2,
119		atom_tail_to_lower_case/2]).
120		:- use_module(probsrc(custom_explicit_sets), [try_expand_custom_set_with_catch/3,
121		is_custom_explicit_set/1, is_set_value/2,
122		singleton_set/2]).
123		:- use_module(probsrc(typing_tools), [any_value_for_type/2]).
124		:- use_module(extrasrc(external_functions_svg), [svg_points/4]).
125		:- use_module(probsrc(store), [lookup_value_for_existing_id/3]).
126		:- use_module(probsrc(gensym), [gensym/2]).
127		:- use_module(probsrc(self_check)).
128		:- use_module(probsrc(external_functions), [external_function_requires_state/1]).
129		:- use_module(probsrc(kernel_reals), [is_real/2]).
130		:- use_module(probsrc(b_global_sets), [add_prob_deferred_set_elements_to_store/3]).
131		:- use_module(probsrc(b_interpreter), [b_compute_expression_nowf/7,
132		b_compute_explicit_epression_no_wf/7]).
133		:- use_module(library(system), [datime/1]).
134		:- use_module(probsrc(version), [version_str/1]).
135		:- use_module(extrasrc(bvisual2), [bv_get_top_level/1, bv_get_value_unlimited/3, bv_top_level_set/2]).
136
137
138		% --------------------------
139
140		% facts storing loaded JSON VisB file:
141		:- dynamic visb_file_loaded/4, visb_svg_file/5, visb_empty_svg_box_height_width/3,
142		visb_definition/6, visb_special_definition/6,
143		visb_item/7,
144		visb_event/6, visb_hover/6, visb_has_hovers/1, visb_has_visibility_hover/1,
145		visb_event_enable_list/5,
146		visb_svg_object/5, visb_svg_object_debug_info/2,
147		visb_svg_child/2, visb_svg_parent/2, % register parent/child relationships for groups, title, ...
148		visb_svg_child_of_object_from_svg_file/1. % true if parent of object is an SVG in an external file
149		:- dynamic auxiliary_visb_event/5.
150		% visb_svg_file(SVGFile, AbsolutePathSVGFile, JSONFileFromWhichWeImportSVG,PosTerm,ModLocTime)
151		% visb_item(SVGID,Attribute,TypedExpression,UsedIds,Description/Comment,StartPos,OtherMetaInfos)
152		% visb_event(SVGID,Event,PredicateList,TypedPredicate,File,Pos)
153		% visb_svg_object(SVGID,SVG_Class,AttrList,Description/Comment,Pos) ; AttrList contains svg_attribute(Attr,Val)
154
155		reset_visb :- debug_println(9,resetting_visb),
156		retractall(visb_file_loaded(_,_,_,_)),
157		retractall(visb_empty_svg_box_height_width(_,_,_)),
158		retractall(visb_svg_file(_,_,_,_,_)),
159		retractall(visb_definition(_,_,_,_,_,_)),
160		retractall(visb_special_definition(_,_,_,_,_,_)),
161		retractall(visb_item(_,_,_,_,_,_,_)),
162		retractall(visb_event(_,_,_,_,_,_)),
163		retractall(visb_hover(_,_,_,_,_,_)),
164		retractall(visb_has_hovers(_)),
165		retractall(visb_has_visibility_hover(_)),
166		retractall(visb_event_enable_list(_,_,_,_,_)),
167		retractall(auxiliary_visb_event(_,_,_,_,_)),
168		retractall(visb_svg_object(_,_,_,_,_)),
169		retractall(visb_svg_object_debug_info(_,_)),
170		retractall(visb_svg_child(_,_)),
171		retractall(visb_svg_child_of_object_from_svg_file(_)),
172		retractall(visb_svg_parent(_,_)),
173		reset_auto_attrs.
174
175		visb_file_is_loaded(JSONFile) :-
176		visb_file_is_loaded(JSONFile,_,true).
177		visb_file_is_loaded(JSONFile,SVGFile,AllowEmpty) :-
178		visb_file_loaded(JSONFile,_,_,_),
179		(visb_svg_file(_,SVGFile,_,_,_) -> true
180		; visb_empty_svg_box_height_width(_,_,_) -> SVGFile = ''
181		; user_has_defined_visb_objects -> SVGFile = ''
182		; JSONFile='' ->
183		AllowEmpty=true,
184		add_warning(visb_visualiser,'No VISB_SVG_FILE or VISB_SVG_OBJECTS specified in DEFINITIONS',''),
185		% Note: warning also generated below No VisB JSON file is specified and no VISB_SVG_OBJECTS were created
186		SVGFile = ''
187		; add_warning(visb_visualiser,'No SVG file or objects specified for VisB file:',JSONFile),
188		AllowEmpty=true,
189		SVGFile = ''
190		).
191
192		no_svg_available :-
193		\+ user_has_defined_visb_objects,
194		no_svg_file_available,
195		\+ visb_empty_svg_box_height_width(_,_,_). % no SVG box provided
196
197		no_svg_file_available :- (visb_svg_file(_,SVGFile,_,_,_) -> SVGFile='' ; true).
198		%svg_file_available :- \+ no_svg_file_available.
199
200		visb_state_can_be_visualised(ID) :-
201		(b_or_z_mode -> visited_state_corresponds_to_setup_constants_b_machine(ID)
202		; ID \= root
203		).
204		visb_current_state_can_be_visualised :-
205		%visb_file_is_loaded(_), % no longer checked; Tcl/Tk will automatically load VisB file if required
206		current_state_id(ID), visb_state_can_be_visualised(ID).
207
208
209		:- register_event_listener(reset_specification,reset_visb,'Reset VisB information').
210		:- register_event_listener(reset_prob,reset_visb,'Reset VisB information').
211
212		%static_check_visb :- % now done when adding items and not storing multiple items
213		% visb_item(ID,Attr,F1,_,_,Pos1), visb_item(ID,Attr,F2,_,Pos2), F1 @< F2,
214		% add_warning(visb_visualiser,'Multiple formulas for SVG identifier and attribute:',ID/Attr,Pos1),
215		% add_message(visb_visualiser,'Location of second formula for:',ID/Attr,Pos2),
216		% fail.
217		% TO DO: some sanity checks on attributes and values
218		static_check_visb :-
219		no_svg_file_available,
220	?	visb_hover(SVGID,_ID,Attr,_Enter,_Exit,Pos),
221		\+ svg_id_exists(SVGID),
222		ajoin(['Hover for attribute ',Attr,' has unknown trigger-id (can lead to blank visualisation): '],Msg),
223		add_warning(visb_visualiser,Msg,SVGID,Pos),
224		fail.
225		static_check_visb :-
226		no_svg_file_available,
227	?	visb_hover(SVGID,ID,Attr,_Enter,_Exit,Pos), ID \= SVGID,
228		\+ svg_id_exists(ID),
229		ajoin(['Hover for attribute ',Attr,' has unknown id (can lead to blank visualisation): '],Msg),
230		add_warning(visb_visualiser,Msg,ID,Pos),
231		fail.
232		static_check_visb :-
233		visb_svg_file(SvgFile,_,_,Pos,_),
234		SvgFile \= '',
235		visb_empty_svg_box_height_width(H,W,ViewBox),
236		ajoin(['VISB_SVG_BOX (width=', W, ', height=', H, ', viewBox=', ViewBox,
237		') cannot be applied to an existing SVG file (use VISB_SVG_CONTENTS for file or put info into SVG file): '],Msg),
238		add_warning(visb_visualiser,Msg,SvgFile,Pos),
239		fail.
240		static_check_visb.
241
242		svg_id_exists(SVGID) :- visb_svg_object(SVGID,_,_StaticAttrList,_,_ExitPos).
243		% --------------------------
244
245
246		% store templates as facts, so that compiled version of probcli does not need to find files
247		:- dynamic visb_template_file_codes/2.
248
249		assert_from_template(Filename) :- %formatsilent('Loading ~w~n',[Filename]),
250		absolute_file_name(visbsrc(Filename), Absolute, []),
251		read_string_from_file(Absolute,String),
252		assertz(visb_template_file_codes(Filename,String)).
253
254		:- assert_from_template('visb_template_header.html').
255		:- assert_from_template('visb_template_svg_downloads.html').
256		:- assert_from_template('visb_template_replayTrace.html').
257		:- assert_from_template('visb_template_middle.html').
258		:- assert_from_template('visb_template_footer.html').
259
260		write_visb_template(HtmlFile,Stream) :-
261		visb_template_file_codes(HtmlFile,Codes),
262		format(Stream,'~s~n',[Codes]).
263
264
265		% --------------------------
266
267
268		get_default_visb_file(Path, Pos) :- get_default_visb_file(Path, _, Pos).
269		get_default_visb_file(Path, Kind, Pos) :- bmachine_is_precompiled,
270		(b_get_definition_string_from_spec('VISB_JSON_FILE', Pos, Path)
271		-> Kind=json % user provided explicit path to VISB JSON file
272		; b_get_definition_string_from_spec('VISB_DEFINITIONS_FILE', Pos, Path)
273		-> Kind=def % user provided explicit path to VISB DEFINITIONS file
274		% TODO: in future check that file extension is compatible
275		% advantage of VISB_DEFINITIONS_FILE == "File" over "File"
276		% 1) visualisation can be re-loaded without re-loading machine
277		% 2) can be used in TLA+ or similar
278		% 3) avoid clash if definitions file itself defines empty VISB_JSON_FILE
279		% 4) avoid problems with Atelier-B or other tools
280		; get_default_visb_svg_file(_,Pos)
281		-> Kind=empty, Path='' % user provided SVG file path
282		; user_has_defined_visb_objects_in_defs
283		-> Kind=empty, Path='' % user provided SVG object definitions
284		).
285
286		user_has_defined_visb_objects :-
287	?	(visb_svg_object(_,_,_,_,_) -> true % created in JSON file
288		; user_has_defined_visb_objects_in_defs).
289
290		user_has_defined_visb_objects_in_defs :-
291		b_sorted_b_definition_prefixed(expression,'VISB_SVG_OBJECTS',_,_).
292
293		% you should do b_absolute_file_name_relative_to_main_machine
294		get_default_visb_svg_file(Path, Pos) :-
295		b_get_definition_string_from_spec('VISB_SVG_FILE', Pos, Path).
296
297
298		% load default VISB_JSON_FILE if it is specified and not already loaded
299		load_default_visb_file_if_necessary :-
300		get_default_visb_file(File, Pos),!,
301		(load_visb_file_if_necessary(File) -> true
302		; add_error(visb_visualiser,'Could not load VISB_JSON_FILE:',File,Pos)).
303		load_default_visb_file_if_necessary :-
304		(eventb_mode -> true ; add_message(visb_visualiser,'No VISB_JSON_FILE DEFINITION provided')).
305
306		% --------------------------
307		% Loading a JSON VisB file:
308
309
310		load_visb_file(File) :-
311		temporary_set_preference(allow_arith_operators_on_reals,true,Old),
312		call_cleanup((load_visb_file1(File)),
313		reset_temporary_preference(allow_arith_operators_on_reals,Old)).
314		load_visb_file1(File) :-
315		get_filename_extension(File,def), % a .def B definition file
316		!,
317		add_message(visb_visualiser,'Loading VisB DEFINITIONS from B file: ',File),
318		b_load_additional_definitions_file(File),
319		load_visb_file2('',File).
320		load_visb_file1(File) :- load_visb_file2(File,File).
321
322		load_visb_definitions_from_list_of_facts(DefFilePath, ListOfFacts) :-
323		temporary_set_preference(allow_arith_operators_on_reals,true,Old),
324		call_cleanup(
325		(b_load_additional_definitions_from_list_of_facts(ListOfFacts),
326		load_visb_file2('', DefFilePath)),
327		reset_temporary_preference(allow_arith_operators_on_reals,Old)).
328
329		load_visb_definitions_from_term(DefFilePath, Machine) :-
330		temporary_set_preference(allow_arith_operators_on_reals,true,Old),
331		call_cleanup(
332		(b_load_additional_definitions_from_term(Machine),
333		load_visb_file2('', DefFilePath)),
334		reset_temporary_preference(allow_arith_operators_on_reals,Old)).
335
336		load_visb_file2(JsonFile,OrigFileName) :-
337		reset_visb,
338		load_visb_from_definitions(no_inlining,JsonFile), % TODO: pass InlineObjects?
339		start_ms_timer(T),
340		(JsonFile='' % No JSON file
341		-> (get_default_visb_svg_file(SvgFile,DefaultSVGPos)
342		-> (SvgFile='' -> AbsFile=SvgFile % just dummy empty string provided by user
343		; b_absolute_file_name_relative_to_main_machine(SvgFile,AbsFile)
344		),
345		add_visb_svg_file(SvgFile,AbsFile,'',DefaultSVGPos)
346		; check_objects_created(JsonFile) % no JSON and SVG file; check we have created objects
347		)
348		; add_visb_file(JsonFile,[]),
349		stop_ms_walltimer_with_msg(T,'loading VisB JSON file: ')
350		),
351		static_check_visb,
352		(OrigFileName = ''
353		-> ModTime=0, ModLocTime=0 % We could get modification time of files with VISB_SVG_OBJECTS, ... DEFINITIONS
354		; file_property(OrigFileName, modify_timestamp, ModTime),
355		file_property(OrigFileName, modify_localtime, ModLocTime)
356		),
357		constants_status(CS),
358		assertz(visb_file_loaded(OrigFileName,ModTime,ModLocTime,CS)).
359
360		% mainly useful for CSP||B where concrete_constants not directly available upon loading machine
361		% TODO: we could compute the number of constant values available and store this (e.g., when MAX_INITIALISATIONS is 0)
362		constants_status(X) :- root_sufficiently_explored,!, X=available.
363		constants_status(not_available).
364
365		check_objects_created(File) :-
366	?	(visb_svg_object(_,_,_,_,_) -> true
367		; add_warning(visb_visualiser,'No VisB JSON file is specified and no VISB_SVG_OBJECTS were created:',File)
368		).
369
370		load_visb_from_definitions(InlineObjects,JsonFileContext) :-
371		start_ms_timer(T),
372		pre_expand_typing_scope([variables_and_additional_defs],ExpandedScope), % do this only once for all defs
373		get_svg_objects_from_definitions(InlineObjects,ExpandedScope,JsonFileContext),
374		(get_SVG_BOX_definition(InlineObjects) -> true ; true), % TODO: also pass scope
375		stop_ms_walltimer_with_msg(T,'extracting VisB infos from DEFINITIONS: ').
376
377
378		%:- use_module(library(system),[now/1, datime/2]).
379		load_visb_file_if_necessary(File) :-
380		visb_file_loaded(File,ModTime1,_,ConstantsStatus), % this file is already loaded
381		constants_status(ConstantsStatus), % if constants status has changed we need to re-load visualisation
382		(File = '' -> true
383		; file_exists(File),
384		file_property(File, modify_timestamp, ModTime2), % check if it has the same time stamp
385		debug_println(19,visb_json_already_loaded(File,ModTime1,ModTime2)),
386		ModTime1=ModTime2
387		),
388		!.
389		load_visb_file_if_necessary(File) :- constants_status(not_available),!,
390		add_message(visb_visualiser,'Not loading VisB file no constants set up yet: ',File).
391		load_visb_file_if_necessary(File) :- load_visb_file(File).
392
393
394		add_visb_file(File,LoadedFiles) :- member(File,LoadedFiles),!,
395		add_error(visb_visualiser,'Circular inclusion of JSON files:',[File|LoadedFiles]).
396		add_visb_file(File,_) :- \+ file_exists(File),!,
397		add_error(visb_visualiser,'JSON file does not exist:',File), fail.
398		add_visb_file(File,LoadedFiles) :-
399		debug_format(19,'Loading JSON File: ~w~n',[File]),
400		set_additional_filename_as_parsing_default(File,NewNr,OldNr),
401		call_cleanup(add_visb_file2(File,LoadedFiles), reset_filename_parsing_default(NewNr,OldNr)).
402
403		add_visb_file2(File,LoadedFiles) :-
404		json_parse_file(File,json(List2),[position_infos(true),multiline_strings(true)]),
405		% tools_printing:trace_print(List2),nl,nl,
406		process_json(List2,File),
407		!,
408		(get_attr_with_pos(include,List2,JsonFileTerm,File,Pos)
409		-> check_json_string(JsonFileTerm,include,Pos,JsonFile),
410		absolute_file_name(JsonFile,AF,[relative_to(File)]),
411		formatsilent('Including JSON file: ~w~n',[JsonFile]),
412		add_visb_file(AF,[File|LoadedFiles])
413		; true
414		),
415		(LoadedFiles=[], % only check for main included file
416	?	get_attr_with_pos('model-name',List2,string(ModelName),File,MPos),
417		b_machine_name(Main), Main \= ModelName
418		-> ajoin(['VisB JSON file expects model-name ',ModelName,' instead of: '],MMsg),
419		add_warning(visb_visualiser,MMsg,Main,MPos)
420		; true
421		).
422		add_visb_file2(File,_) :-
423		add_error(visb_visualiser,'Unable to process JSON file:',File),
424		fail.
425
426		% process json content of a VisB file:
427		process_json(List,JSONFile) :- visb_svg_file(_,_,_,_,_),!, % we have already determined the SVG file
428		process_json2(List,JSONFile).
429		process_json(List,JSONFile) :-
430	?	get_attr_with_pos(svg_box,List,json(BoxList),JSONFile,Pos),
431		% json([=(width,400,3-3),=(height,400,3-3)])
432	?	(get_attr(svg,List,string(SvgFile)) -> SvgFile='' ; true), % check if svg attr empty or non-existant
433		force_get_attr_nr(height,BoxList,H,JSONFile),
434		force_get_attr_nr(width,BoxList,W,JSONFile),!,
435		(get_attr(viewBox,BoxList,string(VB)) -> ViewBox=VB ; ViewBox=''),
436		add_message(visb_visualiser,'Will create empty SVG image with specified dimensions: ',H:W,Pos),
437		assert_visb_empty_svg_box_height_width(H,W,ViewBox,Pos),
438		process_json2(List,JSONFile).
439		process_json(List,JSONFile) :-
440	?	get_attr_with_pos(svg,List,FileTerm,JSONFile,Pos),
441		check_json_string(FileTerm,svg,Pos,File),
442		(File = '' -> get_default_visb_svg_file(SvgFile, _)
443		; get_default_visb_svg_file(SvgFile, DPos)
444		-> add_message(visb_visualiser,'Overriding svg file specified in JSON file: ',File,DPos)
445		; SvgFile=File),
446		!,
447		absolute_file_name(SvgFile,AbsFile,[relative_to(JSONFile)]),
448		add_visb_svg_file(SvgFile,AbsFile,JSONFile,Pos),
449		process_json2(List,JSONFile).
450		process_json(List,JSONFile) :-
451		get_default_visb_svg_file(SvgFile, Pos), SvgFile \= '',
452		!,
453		absolute_file_name(SvgFile,AbsFile,[]), % relative to B machine??
454		add_visb_svg_file(SvgFile,AbsFile,JSONFile,Pos),
455		process_json2(List,JSONFile).
456		process_json(List,JSONFile) :-
457		process_json2(List,JSONFile),
458		(get_SVG_BOX_definition(no_inlining) -> true % TODO: pass (InlineObjects)
459		; get_attr_with_pos(svg,List,_,JSONFile,Pos) -> % File is empty
460		add_message(visb_visualiser,'Creating empty SVG image. You can add a declaration like "svg_box": {"width":W,"height":H} to specify dimensions in: ',JSONFile,Pos)
461		; add_warning(visb_visualiser,'Creating empty SVG image. The JSON file contains no svg attribute (pointing to the SVG file): ',JSONFile)
462		).
463
464		add_visb_svg_file(SvgFile,AbsFile,JSONFile,Pos) :-
465		(SvgFile='' -> add_message(visb_visualiser,'Empty VisB SVG file:',SvgFile,Pos)
466		; file_exists(AbsFile)
467		-> debug_format(19,'SVG file = ~w (~w)~n',[SvgFile, AbsFile]),
468		file_property(AbsFile, modify_localtime, ModLocTime)
469		; add_error(visb_visualiser,'The specified VisB SVG file does not exist:',SvgFile,Pos),
470		ModLocTime=unknown
471		),
472		assertz(visb_svg_file(SvgFile,AbsFile,JSONFile,Pos,ModLocTime)).
473
474		process_json2(List,JSONFile) :-
475		process_json_definitions(List,JSONFile),
476		process_json_items(List,JSONFile),
477		process_json_events(List,JSONFile),
478		process_json_new_svg_objects(List,JSONFile).
479
480
481		check_json_string(Term,_,_,Atom) :- Term = string(Atom), atom(Atom), !.
482		check_json_string(Term,Attr,Pos,_) :- !,
483		ajoin(['Illegal JSON attribute ',Attr,', expected a JSON string:'],Msg),
484		add_error(visb_visualiser,Msg,Term,Pos),fail.
485		% ----------------
486
487		% B definitions that can help write items, events more compactly
488		process_json_definitions(List,File) :-
489	?	get_attr(definitions,List,array(Defs)),!,
490		length(Defs,Len),
491		formatsilent('VisB Definitions: ~w~n',[Len]),
492		maplist(process_json_definition(File),Defs).
493		process_json_definitions(_,_File).
494
495		% VisB items which modify attributes of SVG objects
496		process_json_items(List,File) :-
497	?	get_attr(items,List,array(Items)),!,
498		length(Items,Len),
499		formatsilent('VisB Item declarations: ~w~n',[Len]),
500		maplist(process_visb_json_item(File),Items).
501		process_json_items(_,File) :- \+ visb_special_definition(visb_updates,_,_,_,_,_),!,
502		add_message(visb_visualiser,'The JSON file contains no items: ',File).
503		process_json_items(_,_).
504
505		% VisB events which react to clicks on SVG objects and display hovers
506		process_json_events(List,File) :-
507		get_attr(events,List,array(Items)),!,
508		length(Items,Len),
509		formatsilent('VisB Event declarations: ~w~n',[Len]),
510		maplist(process_json_event(File),Items).
511		process_json_events(_,_).
512
513		% VisB additional SVG objects added to SVG file
514		process_json_new_svg_objects(List,File) :-
515	?	get_attr(svg_objects,List,array(Items)),!,
516		length(Items,Len),
517		formatsilent('VisB additional svg_objects declarations: ~w~n',[Len]),
518		maplist(process_json_svg_object(File),Items).
519		process_json_new_svg_objects(List,File) :-
520		get_attr_with_pos(objects,List,array(Items),File,Pos),!,
521		add_warning(visb_visualiser,'Use "svg_objects" attribute instead of "objects" in: ',File,Pos),
522		maplist(process_json_svg_object(File),Items).
523		process_json_new_svg_objects(_,_).
524
525
526		% evaluate all VISB_SVG_OBJECTS... DEFINITIONS and try and extract SVG objects
527		% this must be a set of records with at least id and svg_class field
528		get_svg_objects_from_definitions(InlineObjects,ExpandedScope,_) :-
529	?	find_and_eval_visb_DEFINITION('VISB_SVG_OBJECTS', visb_objects, SVG_ID, AttrList, Desc, DefName,
530		_DefPos, EvalPos, InlineObjects, allow_separation, ExpandedScope),
531		%formatsilent('Generating new SVG object ~w with attrs ~w~n',[SVG_ID,AttrList]),
532		add_visb_object_from_definition(visb_objects, SVG_ID, AttrList, Desc, DefName, EvalPos),
533		fail.
534		get_svg_objects_from_definitions(InlineObjects,ExpandedScope,_) :-
535		find_and_eval_visb_DEFINITION('VISB_SVG_EVENTS', visb_events, SVG_ID, AttrList, Desc, DefName,
536		_DefPos, EvalPos, InlineObjects, no_separation, ExpandedScope),
537		% attributes: event or events, predicate
538		add_visb_object_from_definition(visb_events, SVG_ID, AttrList, Desc, DefName, EvalPos),
539		fail.
540		get_svg_objects_from_definitions(InlineObjects,ExpandedScope,_) :-
541	?	find_and_eval_visb_DEFINITION('VISB_SVG_HOVERS', visb_hovers, SVG_ID, AttrList, Desc, DefName,
542		_DefPos, EvalPos, InlineObjects, no_separation, ExpandedScope),
543		% attributes: id, trigger_id (optional), other SVG attributes
544		add_visb_hovers_from_definition(SVG_ID, AttrList, Desc, DefName, EvalPos),
545		fail.
546		get_svg_objects_from_definitions(_InlineObjects,ExpandedScope,JsonFileContext) :- % VISB_SVG_UPDATES
547		precompile_svg_object_updates(ExpandedScope,JsonFileContext).
548
549		% example definition VISB_SVG_HOVERS == rec(`id`:"myid", stroke:"black", stroke_exit:"gray");
550		% a hovers field inside VISB_SVG_OBJECTS can be something like:
551		% rec(.... hovers: (rec(class:"train-hover"),rec(trigger_id:"track_polyline",class:"train-hover")), ...)
552		% also used, e.g., as attribute in VISB_SVG_OBJECTS
553		add_visb_hovers_from_definition(SVG_ID,AttrList, Desc, DefName, DefPos) :-
554		select(svg_attribute(hovers,Hovers),AttrList,AttrList2),
555		!,
556		(AttrList2=[] -> true ; add_warning(visb_visualiser,'Unknown extra hover attributes:',AttrList2,DefPos)),
557		flex_member(Record,Hovers,DefName,DefPos),
558		(get_VISB_record_fields(Record,Fields) -> true
559		; add_warning(visb_visualiser,'VisB hovers field value is not a record of SVG attributes: ',Record,DefPos),fail),
560		include_maplist(extract_attribute_from_record(DefPos),Fields,HoverAttrList),
561		add_visb_object_from_definition(visb_hovers, SVG_ID, HoverAttrList, Desc, DefName, DefPos).
562		add_visb_hovers_from_definition(SVG_ID,AttrList, Desc, DefName, DefPos) :-
563		add_visb_object_from_definition(visb_hovers, SVG_ID, AttrList, Desc, DefName, DefPos).
564
565
566		% add a VisB record object from a HOVER or OBJECT definition:
567		add_visb_object_from_definition(visb_objects,SVG_ID, AttrList, Desc, DefName, DefPos) :- !,
568	?	(select(svg_attribute(svg_class,SVG_Class),AttrList,AttrList2)
569		-> true % maybe we should call svg_class svg_shape and
570		% allow html_tag for children of foreignObject
571		; add_warning(visb_visualiser,'SVG objects have no svg_class field: ',DefName,DefPos),
572		fail
573		),
574		assert_visb_svg_object(SVG_ID,SVG_Class,AttrList2,Desc,DefName,DefPos).
575		add_visb_object_from_definition(visb_hovers,SVG_ID, AttrList, _Desc, _DefName, DefPos) :- !,
576		(select(svg_attribute(trigger_id,TriggerID),AttrList,AttrList2) -> true
577		; select(svg_attribute('trigger-id',TriggerID),AttrList,AttrList2) -> true
578		; TriggerID = SVG_ID, AttrList2=AttrList),
579		member(svg_attribute(Attr,EnterVal),AttrList2), % will backtrack for every SVG attribute
580		\+ get_exit_attribute_name(_,Attr), % it is not an exit attribute
581		get_exit_attribute_name(Attr,AttrExitName),
582		(member(svg_attribute(AttrExitName,ExitVal), AttrList2) -> true % user specified exit value explicitly
583		; visb_svg_object(SVG_ID,_,StaticAttrList,_,ExitPos)
584		-> (member(svg_attribute(Attr,ExitVal),StaticAttrList) -> true % use value specified in VISB_SVG_OBJECTS
585		; default_attribute_value(Attr,ExitVal)
586		-> add_message(visb_visualiser,'Assuming default hover exit value for attribute: ',Attr,DefPos)
587		; Attr = 'svg_class'
588		-> add_warning(visb_visualiser,
589		'svg_class cannot be set in hover for: ',SVG_ID,ExitPos),
590		ExitVal=EnterVal
591		; (Attr = hover ; Attr = hovers) ->
592		add_error(visb_visualiser,
593		'Only provide SVG attributes here; no need to wrap them in this attribute:',Attr,DefPos),fail
594		; add_warning(visb_visualiser,
595		'No static (exit) value can be retrieved for hover for attribute (be sure to define a static value for this attribute in a VISB_SVG_OBJECT definition): ',Attr,ExitPos),
596		ExitVal=EnterVal
597		)
598		; ajoin(['No VISB_SVG_OBJECT for id ',SVG_ID,' and no value for ',AttrExitName,
599		'; cannot retrieve hover exit value for attribute: '],Msg),
600		add_warning(visb_visualiser,Msg,Attr,DefPos),
601		fail %ExitVal=EnterVal
602		),
603		assert_visb_hover(TriggerID,SVG_ID,Attr,EnterVal,ExitVal,DefPos).
604		add_visb_object_from_definition(visb_events,SVG_ID, AttrList, _Desc, DefName, DefPos) :- !,
605		( select(svg_attribute(event,Event),AttrList,AttrList1) -> true
606		; select(svg_attribute(events,Events),AttrList,AttrList1) -> % we have events attributes with multiple events
607		flex_member(EvVal,Events,DefName,DefPos),
608		extract_attr_value(event,EvVal,Event,DefPos)
609		; AttrList = [_|_], % at least one other attribute than id; otherwise it may stem from separating VISB_SVG_OBJECTS
610		add_warning(visb_visualiser,'Missing event attribute in VisB definition: ',DefName,DefPos),
611		fail
612		),
613		(select(svg_attribute(predicate,Pred),AttrList1,AttrList2) -> Preds=[Pred]
614		; member(P,[preds,predicates]),
615		select(svg_attribute(P,Pred),AttrList1,AttrList2)
616		-> Preds=[Pred], add_warning(visb_visualiser,'Use predicate as attribute for VisB events instead of: ',P,DefPos)
617		; Preds=[], AttrList2=AttrList1
618		),
619		EnableItems=[],
620		maplist(warn_remaining_attributes(DefName,DefPos),AttrList2),
621		% TODO extract from AttrList2: visb_enable_item(SvgID,Attr,EnabledValExpr,DisabledValExpr,PosAttr)
622		(error_manager:extract_file_number_and_name(DefPos,_,File) -> true ; File='?'),
623		PredPos = DefPos, %TODO: improve
624		add_visb_event(SVG_ID,Event,Preds,[],EnableItems,File,DefPos,PredPos,[]).
625		add_visb_object_from_definition(SpecialClass,_, _, _, _DefName, DefPos) :-
626		add_warning(visb_visualiser,'Unknown special class, cannot add VisB objects for definition: ',SpecialClass,DefPos).
627
628		% for hovers allow to explicitly specify exit value, in case the SVG object comes from an SVG file
629		get_exit_attribute_name(Attr,ExitAttr) :- atom_concat(Attr,'_exit',ExitAttr).
630
631		warn_remaining_attributes(DefName,DefPos,svg_attribute(hover,_)) :- !,
632		add_warning(visb_visualiser,'Attribute hover not supported here (use separate VISB_SVG_HOVERS definition): ',DefName,DefPos).
633		warn_remaining_attributes(DefName,DefPos,svg_attribute(hovers,_)) :- !,
634		add_warning(visb_visualiser,'Attribute hovers not supported here (use separate VISB_SVG_HOVERS definition): ',DefName,DefPos).
635		warn_remaining_attributes(_,DefPos,Attr) :-
636		add_warning(visb_visualiser,'Unrecognised attribute in VISB_SVG_EVENTS definition: ',Attr,DefPos).
637
638
639		default_attribute_value(fill,black). % is remove for animate, ...
640		default_attribute_value(opacity,1).
641		default_attribute_value('stop-dasharray',none).
642		default_attribute_value('stop-opacity',1).
643		default_attribute_value('stroke-opacity',1).
644		default_attribute_value('stroke-width','1px').
645		default_attribute_value(stroke,none).
646		default_attribute_value(transform,none).
647		default_attribute_value(visibility,visible).
648
649		% is called in process_json when no SVG file specified
650		% VISB_SVG_BOX == rec(width:1000,height:1000,viewBox:"minx miny w h"),
651		get_SVG_BOX_definition(InlineObjects) :-
652	?	get_and_eval_special_definition('VISB_SVG_BOX','VISB_SVG_BOX',visb_box,DefPos,ResValue,InlineObjects),
653		(ResValue=(BH,BW) -> ViewBox=''
654		; get_VISB_record_fields(ResValue,Fields),
655	?	select(field(height,BH),Fields,F1),
656	?	select(field(width,BW),F1,F2)
657	?	-> (select(field(viewBox,VBVal),F2,F3)
658		-> (VBVal=string(VB) -> ViewBox=VB
659		% Viewbox is "mx my w h" string, ie: minimum_x, minimum_y, width and height
660		; VBVal = rec(VBFields)
661		-> (get_view_box_rec(VBFields,DefPos,ViewBox) -> true
662		; ViewBox='',
663		add_warning(visb_visualiser,'VISB_SVG_BOX viewBox record has illegal fields (expected minx miny width height):',VBVal,DefPos))
664		; add_warning(visb_visualiser,'VISB_SVG_BOX viewBox is not a string ("minx miny width height") or record:',VBVal,DefPos),
665		ViewBox=''
666		)
667		; ViewBox='', F3=F2
668		),
669		(F3=[] -> true
670		; add_warning(visb_visualiser,'VISB_SVG_BOX unknown attributes (not height, width, viewBox): ',F2,DefPos))
671		; add_error(visb_visualiser,'Ignoring VISB_SVG_BOX, must be record or pair of integers (height,width):',ResValue,DefPos)),
672		(get_number_from_bvalue(BH,H) -> true
673		; add_error(visb_visualiser,'VISB_SVG_BOX Height is not a number:',ResValue,DefPos)),
674		(get_number_from_bvalue(BW,W) -> true
675		; add_error(visb_visualiser,'VISB_SVG_BOX Width is not a number:',ResValue,DefPos)),
676		!,
677		assert_visb_empty_svg_box_height_width(H,W,ViewBox,DefPos).
678
679		get_view_box_rec([field(height,VH),field(minx,MXH),field(miny,MYH),field(width,VW)],DefPos,ViewBoxString) :-
680		(get_number_from_bvalue(VH,Height) -> true
681		; add_error('VISB_SVG_BOX viewBox\'height is not a number:',VH,DefPos),fail),
682		(get_number_from_bvalue(VW,Width) -> true
683		; add_error('VISB_SVG_BOX viewBox\'width is not a number:',VH,DefPos),fail),
684		(get_number_from_bvalue(MXH,MinX) -> true
685		; add_error('VISB_SVG_BOX viewBox\'minx is not a number:',VH,DefPos),fail),
686		(get_number_from_bvalue(MYH,MinY) -> true
687		; add_error('VISB_SVG_BOX viewBox\'miny is not a number:',VH,DefPos),fail),
688		ajoin([MinX,' ',MinY,' ', Width,' ',Height],ViewBoxString).
689
690
691		assert_visb_empty_svg_box_height_width(H,W,_ViewBox,Pos) :-
692		retract(visb_empty_svg_box_height_width(OldH,OldW,_)),
693		(OldH,OldW) \= (H,W),
694		add_message(visb_visualiser,'Overriding VisB SVG_BOX default dimensions: ',(OldH,OldW),Pos),
695		fail.
696		assert_visb_empty_svg_box_height_width(H,W,ViewBox,_Pos) :-
697		%add_message(visb_visualiser,'Setting VisB SVG_BOX default dimensions: ',(H,W,ViewBox),Pos),
698		assert(visb_empty_svg_box_height_width(H,W,ViewBox)).
699
700
701		% find DEFINITION with given prefix in name, evaluate it and return SVG_ID and attribute list:
702		% AllowSep = allow_seperation means that the record fields can be separated into static objects and dynamic updates
703		% and only static ones will be retained (dynamic ones dealt with later)
704		find_and_eval_visb_DEFINITION(DEFPREFIX, Kind, SVG_ID, AttrList,Desc, DefName, DefPos,EvalPos,
705		InlineObjects,AllowSep,ExpandedScope) :-
706	?	( b_sorted_b_definition_prefixed(expression,DEFPREFIX,DefName,DefPos),
707	?	if(b_get_typed_definition(DefName,ExpandedScope,Body),true,
708		(add_visb_lint_message('Ignoring VisB DEFINITION due to errors',DefName,DefPos),fail))
709		; special_backup(DEFPREFIX,Kind),
710		% also look at stored definitions (e.g., from static/dynamic separation of VISB_SVG_OBJECTS)
711		visb_special_definition(Kind,DefName,_Type,Body,_Class,DefPos)
712		),
713		set_error_context(visb_error_context(definition,DefName,'all_attributes',DefPos)),
714	?	call_cleanup((get_typed_static_definition_with_constants_state(DefName,Body,
715		ResBody,DefPos,ConstState,InlineObjects,AllowSep),
716		(get_texpr_pos(ResBody,Pos0) -> true ; Pos0=DefPos), % this could be a part of the full definition body
717		get_visb_DEFINITION_svg_object(Kind,DefName,ResBody,Pos0,ConstState,SVG_ID,AttrList,Desc,EvalPos)),
718		clear_error_context).
719
720		special_backup('VISB_SVG_HOVERS',visb_hovers).
721
722		% evaluate a typed body expressions evaluating to a record or set of records
723		% and translate into SVG attribute lists:
724		get_visb_static_svg_object_for_typed_expr(Kind,DefName,Body,DefPos,SVG_ID,AttrList,Desc,InnerPos) :-
725		AllowSep=no_separation,
726		Inline=no_inlining,
727		get_typed_static_definition_with_constants_state(DefName,Body,ResBody,DefPos,ConstState,Inline,AllowSep),
728		get_visb_DEFINITION_svg_object(Kind,DefName,ResBody,DefPos,ConstState,SVG_ID,AttrList,Desc,InnerPos).
729
730
731		flatten_couple(b(couple(A,B),_,_)) --> !,flatten_couple(A),flatten_couple(B).
732		% we could also flatten union(A,B), but at the risk of duplicate warnings when the same element occurs in A and B
733		flatten_couple(A) --> [A].
734
735		get_typed_static_definition_with_constants_state(DefName,Body,ResBody,DefPos,ConstantsState,InlineObjects,AllowSep) :-
736		flatten_couple(Body,TupleList,[]),
737		% the VISB_SVG_OBJECT definition may consist of a tuple (Obj1,Obj2,...) to allow grouping
738		(TupleList = [_,_|_]
739		-> add_debug_message(visb_visualiser,'Decomposed VisB definition body tuple:',DefName,DefPos)
740		; true),
741	?	nth1(DefNr,TupleList,TupleBody),
742		(get_texpr_pos(TupleBody,TuplePos) -> true ; TuplePos=DefPos),
743		get_typed_static_definition_with_constants_state3(DefName,DefNr,TupleBody,ResBody,TuplePos,
744		ConstantsState,InlineObjects,AllowSep).
745		get_typed_static_definition_with_constants_state3(DefName,DefNr,Body,ResBody,DefPos,ConstantsState,InlineObjects,AllowSep) :-
746		determine_type_of_visb_formula(Body,TIds,Class),
747		debug_format(19,'Detected VisB DEFINITION ~w (~w)~n',[DefName,Class]),
748		(%Class=requires_variables, % now also useful if event field present
749		AllowSep=allow_separation, % allowed for VISB_SVG_OBJECTS
750	?	if(separate_into_static_and_dynamic_part(DefName,DefNr,Body,StaticBody,DynamicBody,EventBody,HoverBody),
751		true,
752		(get_texpr_type(Body,Type),
753		(contains_events_or_hovers_field(Type)
754		-> add_warning(visb_visualiser,'Static/Dynamic separation failed for (required for events or hovers): ',DefName,DefPos)
755		% VISB_SVG_OBJECT definition contains events/hovers and as such requires separation; which failed here
756		; add_debug_message(visb_visualiser,'Static/Dynamic separation failed or not useful for: ',DefName,DefPos)
757		),
758		fail)),
759		determine_type_of_visb_formula(StaticBody,SIds,SClass),
760		get_unique_initial_state_for_visb(SClass,DefName,DefPos,SIds,ConstantsState)
761		-> Separated=true, ResBody=StaticBody,
762		add_debug_message(visb_visualiser,'Automatically separated fields into static and dynamic: ',DefName,DefPos),
763		%write('STATIC: '),translate:print_bexpr(StaticBody),nl, write('DYNAMIC: '),translate:print_bexpr(DynamicBody),nl,
764		assert_visb_udpate_def_body(visb_updates,DefName,DynamicBody,DefPos),
765		add_visb_events_from_def_body(visb_events,DefName,EventBody,DefPos),
766		assert_visb_udpate_def_body(visb_hovers,DefName,HoverBody,DefPos) % needs to be asserted so that it can be evaluated after svg objects have been created to extract exit value
767		; get_unique_initial_state_for_visb(Class,DefName,DefPos,TIds,ConstantsState)
768		-> ResBody=Body
769		; ResBody=Body,
770		(Class=requires_constants ->
771		get_texpr_ids(TIds,Ids),
772		% we could check if values of Ids are identical in all constants solutions
773		(is_concrete_constants_state_id(_)
774		-> BMsg='multiple solutions for used constants exist: '
775		; \+ root_sufficiently_explored
776		-> BMsg='no constants were setup yet: '
777		% two cases below should not happen; but happen on Linux with CSP||B models
778		; state_space:logical_transition_from_root(RID),
779		state_space:packed_visited_expression(RID,RSt),
780		functor(RSt,RFun,RArity)
781		-> ajoin(['no constants were found, but logical successor ',RFun,'/',RArity,
782		' with id ', RID,' of root exists: '],BMsg)
783		; BMsg='no constants were found: '
784		),
785		ajoin(['DEFINITION ',DefName, ' requires constants but ',BMsg],Msg),
786		(get_a_constants_state(ConstantsState,StateID,InlineObjects)
787		-> (member(CstID,Ids),
788		other_constant_value_exists_for(CstID,ConstantsState,StateID)
789		-> add_warning(visb_visualiser,Msg,CstID,DefPos)
790		; ajoin(['DEFINITION ',DefName,
791		' requires constants and all SETUP_CONSTANTS solutions have same value thus far: '],Msg2),
792		% constraint-based checks or execute by predicate could later create others !
793		add_message(visb_visualiser,Msg2,Ids,DefPos)
794		)
795		; add_error(visb_visualiser,Msg,Ids,DefPos),
796		fail % avoid other subsequent errors when evaluating with ConstantsState=[]
797		)
798		; ConstantsState=[]
799		)
800		),
801		(Class=requires_variables, Separated=false
802		-> get_texpr_ids(TIds,AIds),
803		include(b_is_variable,AIds,VIds),
804		ajoin_with_sep(VIds,',',SVids),
805		(get_preference(visb_allow_variables_for_objects,false)
806		-> ajoin(['Ignoring DEFINITION which requires variables ',SVids,': '],WMsg),
807		add_warning(visb_visualiser,WMsg,DefName,DefPos),fail
808		; ConstantsState=[]
809		-> add_warning(visb_visualiser,'Ignoring DEFINITION which requires variables, could not find unique initial state: ',DefName,DefPos),fail
810		; ajoin(['DEFINITION requires variables ',SVids,
811		'; exporting history to HTML may not work correctly'],WMsg),
812		add_visb_lint_message(WMsg,DefName,DefPos)
813		)
814		; true).
815
816
817		% separate/split/filter VISB_SVG_OBJECTS definitions into a static part and a dynamic part depending on variables
818		% (aka updates/items)
819		separate_into_static_and_dynamic_part(DefName,DefNr,Body,StaticBody,DynamicBody,EventBody,HoverBody) :-
820	?	separate_static_dyn_aux(DefName,DefNr,[],[],Body,StaticBody,DynamicBody,EventBody,HoverBody).
821
822
823		rewrite_expression(let_expression(Ids,Exprs,Body),NewBody) :-
824		% currently we cannot process LET's here, expand them
825		replace_ids_by_exprs(Body,Ids,Exprs,NewBody). % see also expand_all_lets/2
826
827		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,Path,b(Expr,_Type,_Info), Static,Dynamic,Event,Hover) :-
828		rewrite_expression(Expr,NewExpr),!,
829		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,Path,NewExpr, Static,Dynamic,Event,Hover).
830		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,Path,b(couple(A,B),_,_Info),
831		StaticCouple,DynamicCouple,EventCouple,HoverCouple) :- !,
832		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,[0|Path],A,SA,DA,EA,HA),
833		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,[1|Path],B,SB,DB,EB,HB),
834		create_couple(SA,SB,StaticCouple),
835		create_couple(DA,DB,DynamicCouple),
836		create_couple(EA,EB,EventCouple),
837		create_couple(HA,HB,HoverCouple).
838		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,Path,TExpr,
839		b(StaticSetComp,set(ST),I),
840		b(DynamicSetComp,set(DT),I),
841		b(EventsSetComp,set(ET),I),
842		b(HoversSetComp,set(HT),I)) :-
843	?	bsyntaxtree:is_eventb_comprehension_set(TExpr,Ids,Pred,Expr),
844		(OuterQuantifiedIds = []
845		-> add_debug_message(visb_visualiser,'Top-level set comprehensions for VISB: ',Ids,TExpr)
846		; add_message(visb_visualiser,'Nested set comprehensions for VISB: ',OuterQuantifiedIds,TExpr)
847		),
848		!,
849		determine_type_of_visb_formula(b(exists(Ids,Pred),pred,[]),SIds,Class),
850		(get_unique_initial_state_for_visb(Class,DefName,Pred,SIds,_)
851		-> true % The predicate must be statically executable
852		; time_out_for_node(root,O,_Type),
853		translate_operation_name(O,Op) ->
854		ajoin(['Due to TIME_OUT of ',Op,' the comprehension set domain cannot be evaluated: '],Msg),
855		add_warning(visb_visualiser,Msg,Pred,Pred),
856		% TODO: avoid other error messages that will occur after that
857		fail
858		; (root_sufficiently_explored -> RMsg = '' ; RMsg = ' because constants were not set up yet'),
859		(multiple_concrete_constants_exist -> MMsg = ',multiple SETUP_CONSTANTS exist' ; MMsg = ''),
860		ajoin(['Cannot evaluate comprehension set domain (',Class,MMsg,')',RMsg],LMsg),
861		add_visb_lint_message(LMsg,Pred,Pred),
862		% at the moment we require the domain to be computable statically for both static/dynamic attributes
863		fail
864		),
865		append(OuterQuantifiedIds,Ids,NewOuterQuantifiedIds),
866	?	separate_static_dyn_aux(DefName,DefNr,NewOuterQuantifiedIds,Path,Expr,
867		StaticRec,DynamicRec,EventRec,HoverRec),
868		get_texpr_type(StaticRec,ST),
869		get_texpr_type(DynamicRec,DT),
870		get_texpr_type(EventRec,ET),
871		get_texpr_type(HoverRec,HT),
872		bsyntaxtree:get_texpr_info(TExpr,I),
873		b_ast_cleanup:rewrite_event_b_comprehension_set(Ids,StaticRec,Pred, set(ST), StaticSetComp),
874		b_ast_cleanup:rewrite_event_b_comprehension_set(Ids,DynamicRec,Pred,set(DT), DynamicSetComp),
875		b_ast_cleanup:rewrite_event_b_comprehension_set(Ids,EventRec,Pred,set(ET), EventsSetComp),
876		b_ast_cleanup:rewrite_event_b_comprehension_set(Ids,HoverRec,Pred,set(HT), HoversSetComp).
877		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,Path,b(rec(Fields),_,Info),
878		b(rec(StaticFields),record(SFT),Info), % VISB_OBJECTS (static)
879		b(UpdateRecWithDynamicFields,record(DFT),Info), % VISB_UPDATES (dynamic)
880		b(rec(AllEventFields),record(EFT),Info), % VISB_EVENTS
881		b(rec(AllHoverFields),record(HFT),Info) % VISB_HOVERS
882		) :- !,
883		split_list(is_visb_event_field,Fields,EventFields,ObjectAndHoverFields),
884		(select(field(hovers,HoverRec),ObjectAndHoverFields,ObjectFields)
885		-> HoverFields = [field(hovers,HoverRec)] % record deconstructed in add_visb_hovers_from_definition
886		; ObjectFields=ObjectAndHoverFields, HoverFields = []),
887		% maplist(check_field_is_supported(Info),ObjectFields), % will lead to duplicate warning messages, check_visb_update_type e.g., will be called for dynamic updates
888		separate_fields(ObjectFields,StaticFields0,DynamicFields,DefName),
889	?	(member(field(svg_class,_SVG_Class),StaticFields0) -> true
890		; member(field(svg_class,SVG_Class),DynamicFields)
891		-> add_warning(visb_visualiser,'SVG svg_class field is not static in: ',DefName,SVG_Class),
892		fail
893		; add_warning(visb_visualiser,'No svg_class field in: ',DefName,Info),
894		fail
895		),
896	?	(member(field(id,SVGID),StaticFields0)
897		-> (DynamicFields \= [] ; EventFields \= [] ; HoverFields \= [] % separation is useful for this record
898		; Path \= [] % we are part of a couple; maybe other records have a dynamic,event or hover part; so proceed
899		),
900		StaticFields = StaticFields0,
901		TStatic_SVGID = SVGID
902		; member(field(id,SVGID),DynamicFields)
903		-> add_warning(visb_visualiser,'SVG id field is not static in: ',DefName,SVGID),
904		fail
905		; OuterQuantifiedIds = []
906		-> gensym(svg_id,GenID),
907		ajoin(['Generated id ',GenID, ' for SVG object without id field in: '],Msg),
908		add_debug_message(visb_visualiser,Msg,DefName,Info),
909		SVGID = b(string(GenID),string,[]),
910		sort([field(id,SVGID) | StaticFields0],StaticFields)
911		; % the record is quantified within a set comprehension; we need to compute the ID from OuterQuantifiedIds
912		% it has to be identical for VISB_SVG_OBJECTS and VISB_SVG_UPDATES
913		SVGID = b(ExtFunCall,string,[]),
914		convert_path_to_int(Path,IntPath),
915		PathExpr = b(integer(IntPath),integer,[]),
916		create_couple([b(string(DefName),string,[]),b(integer(DefNr),integer,[]),PathExpr|OuterQuantifiedIds],Tuple),
917		% add DefName and DefNr to avoid clash if other Definition has same quantified ids
918		ExtFunCall = external_function_call('SHA_HASH_HEX',[Tuple]),
919		add_debug_message(visb_visualiser,'Generated SHA_HASH_HEX call for id of SVG objects without id field in: ',DefName,Info),
920		sort([field(id,SVGID) | StaticFields0],StaticFields)
921		),
922		maplist(get_field_type,StaticFields,SFT),
923		( (select(field(visibility,VisibExpr),DynamicFields,RestDynamicFields)
924		; member(field(visibility,VisibExpr),StaticFields0), % the visibility expression is static
925		RestDynamicFields = DynamicFields
926		),
927		RestDynamicFields = [_|_],
928		\+ hovers_can_set_visibility(HoverFields),
929		(nonvar(TStatic_SVGID), TStatic_SVGID = b(string(Static_SVGID),_,_) % TODO: evaluate properly
930		-> \+ visb_has_visibility_hover(Static_SVGID) % TODO: check no other hover definition added later
931		; true) % the ID is generated and cannot be accessed by other hovers which could make object visible
932		-> % create IF-THEN-ELSE to avoid evaluating fields when object not visible; also fixes WD issues
933		TRUE = b(boolean_true,boolean,[]),
934		sort([field(id,SVGID),field(visibility,TRUE)|RestDynamicFields],AllDynamicFields),
935		maplist(construct_dummy_value,RestDynamicFields,RestDummyFields),
936		sort([field(id,SVGID),field(visibility,b(boolean_false,boolean,[]))|RestDummyFields],AllDummyFields),
937		create_visibility_check(VisibExpr,VisibilityCond),
938		UpdateRecWithDynamicFields = if_then_else(VisibilityCond,
939		b(rec(AllDynamicFields),record(DFT),Info),
940		b(rec(AllDummyFields),record(DFT),Info)),
941		add_debug_message(visb_visualiser,'Refactoring VisB Record with visibility attribute: ',VisibilityCond)
942		% ,translate:print_bexpr(b(UpdateRecWithDynamicFields,any,[])),nl
943		; sort([field(id,SVGID)|DynamicFields],AllDynamicFields), % TODO: use kernel_records
944		UpdateRecWithDynamicFields = rec(AllDynamicFields)
945		),
946		maplist(get_field_type,AllDynamicFields,DFT),
947		sort([field(id,SVGID)|EventFields],AllEventFields), % ditto
948		maplist(get_field_type,AllEventFields,EFT),
949		sort([field(id,SVGID)|HoverFields],AllHoverFields), % ditto
950		maplist(get_field_type,AllHoverFields,HFT).
951		separate_static_dyn_aux(DefName,DefNr,OuterQuantifiedIds,_Path,TEXPR, _, _, _,_) :-
952		ajoin(['Uncovered expression for ',DefName,'-',DefNr,' ',OuterQuantifiedIds],Msg),
953		add_debug_message(visb_visualiser,Msg,TEXPR,TEXPR),fail.
954
955		hovers_can_set_visibility(HoverFields) :- member(field(hovers,Expr),HoverFields),
956		hover_expr_can_set_visibility(Expr).
957
958		hover_expr_can_set_visibility(b(E,_,_)) :- hovers_can_set_visib_aux(E).
959		hovers_can_set_visib_aux(couple(A,B)) :- !, (hover_expr_can_set_visibility(A) ; hover_expr_can_set_visibility(B)).
960		hovers_can_set_visib_aux(rec(Fields)) :- !, member(field(visibility,_),Fields).
961		hovers_can_set_visib_aux(set_extension(L)) :- !, member(E,L), hover_expr_can_set_visibility(E).
962		hovers_can_set_visib_aux(E) :- write(assume_hover_can_set_visibility(E)),nl.
963		% TODO: synchronise with flex_expand and check we cover all relevant cases like partial functions
964
965
966		create_visibility_check(VisibExpr,VisibilityCond) :- get_texpr_type(VisibExpr,string),!,
967		static_check_attribute_value_expression(visibility,VisibExpr),
968		VISIBLE = b(string('visible'),string,[]),
969		create_equality(VisibExpr,VISIBLE,VisibilityCond).
970		create_visibility_check(VisibExpr,VisibilityCond) :- get_texpr_type(VisibExpr,boolean),!,
971		TRUE = b(boolean_true,boolean,[]),
972		create_equality(VisibExpr,TRUE,VisibilityCond).
973		create_visibility_check(VisibExpr,b(truth,pred,[])) :-
974		add_warning(visb_visualiser,'The attribute visibility is not of type STRING or BOOL: ',VisibExpr,VisibExpr).
975
976
977		construct_dummy_value(field(Name,TExpr),field(Name,b(value(DummyValue),Type,[]))) :-
978		get_texpr_type(TExpr,Type),
979		get_default_or_dummy_value(Type,Name,DummyValue). % object not visible: do not evaluate expression; use dummy value
980
981		get_default_or_dummy_value(string,Name,DummyValue) :-
982		svg_attribute_default_value(Name,Default),!,
983		DummyValue=string(Default).
984		get_default_or_dummy_value(Type,_Name,DummyValue) :- any_value_for_type(Type,DummyValue).
985
986
987		% treat path of 0,1 as binary number, but add 1 at end to distinguish [0,0] and [0] or [1,0] and [1,0,0]
988		convert_path_to_int([],1).
989		convert_path_to_int([H|T],Res) :- convert_path_to_int(T,IT),
990		Res is IT*2+H.
991
992		% is the name of a field for events inside a VISB_SVG_OBJECT record
993		% example rec(..., event:"BOperation", predicate:"x=TRUE")
994		is_visb_event_field(field(Name,_)) :- is_visb_event_field_name(Name).
995		is_visb_event_field_name(event).
996		is_visb_event_field_name(events). % tuple or set of events inside VISB_SVG_OBJECTS
997		is_visb_event_field_name(predicate).
998		is_visb_event_field_name(predicates). % will generate warning
999		is_visb_event_field_name(preds). % will generate warning
1000		% is the name of a field for hovers inside a VISB_SVG_OBJECT record
1001		is_visb_hover_field_name(hovers).
1002		is_visb_hover_field_name(items). % enable items
1003		%is_visb_hover_field_name(optional). % not needed ?
1004		%is_visb_hover_field_name(override). % not needed ?
1005
1006		% check if the type of a VISB_SVG_OBJECTS expression requires separation for hovers/events
1007		contains_events_or_hovers_field(set(X)) :- contains_events_or_hovers_field(X).
1008		contains_events_or_hovers_field(couple(A,B)) :-
1009		(contains_events_or_hovers_field(A) -> true ; contains_events_or_hovers_field(B)).
1010		contains_events_or_hovers_field(record(F)) :- member(field(Name,_),F),
1011		(is_visb_event_field_name(Name) -> true ; is_visb_hover_field_name(Name)).
1012
1013		get_field_type(field(Name,Expr),field(Name,T)) :- get_texpr_type(Expr,T).
1014
1015		% separate fields from a SVG/VISB_SVG_OBJECT record into static part and dynamic update expressions
1016		separate_fields([],[],[],_).
1017		separate_fields([field(Field,Expr)|T],[field(Field,Expr)|TS],TD,DefName) :-
1018		is_static_expr(Expr,Field,DefName),!,
1019		separate_fields(T,TS,TD,DefName).
1020		separate_fields([field(Field,Expr)|T],[field(Field,Default)|TS],[field(Field,Expr)|TD],DefName) :-
1021		requires_static_default_value(Field,Default), !,
1022		separate_fields(T,TS,TD,DefName).
1023		separate_fields([H|T],TS,[H|TD],DefName) :-
1024		separate_fields(T,TS,TD,DefName).
1025
1026		% fields which require a static default value; here to set up child SVG objects of title
1027		% static default values could also be useful for hovers in general?
1028		requires_static_default_value(title,b(string('-title-not-set-'),string,[])).
1029
1030		% virtual SVG attributes which are translated to children tags/objects
1031		attribute_automatically_creates_children(title).
1032
1033		is_static_expr(Expr,Field,DefName) :-
1034		determine_type_of_visb_formula(Expr,_TIds,Class), % TODO pass local variables from exists above
1035		(Class=requires_nothing -> true
1036		; Class=requires_constants,
1037		\+ multiple_concrete_constants_exist, % TODO: check if _TIds have multiple solutions
1038		is_concrete_constants_state_id(_) -> true
1039		; ajoin(['Detected dynamic expression for field ',Field,' in ',DefName,': '],Msg),
1040		add_debug_message(visb_visualiser,Msg,Expr,Expr),fail
1041		).
1042
1043		% --------
1044
1045
1046		extract_attribute_from_record(DefPos,field(OrigName,Value),svg_attribute(Name,SVal)) :-
1047		opt_rewrite_field_name(OrigName,Name),
1048		extract_attribute_value(DefPos,Name,Value,SVal).
1049		extract_attribute_from_record(DefPos,F,_) :-
1050		add_error(bvisualiser,'Extract SVG attribute failed: ',F,DefPos),fail.
1051
1052		% extract a value for a particular field Name
1053		extract_attribute_value(DefPos,Name,Value,SVal) :-
1054		(deconstruct_singleton_set(Name,Value,Element)
1055		-> Element \= '$optional_field_absent',
1056		extract_attr_value(Name,Element,SVal,DefPos)
1057		; extract_attr_value(Name,Value,SVal,DefPos)
1058		).
1059
1060
1061		% in TLA+ mode optional record fields have {TRUE|->VALUE} rather than VALUE
1062		% this can also be useful in B to allow mixing different SVG records in a set
1063		% for Alloy mode we may want to also support singleton sets as scalars
1064		deconstruct_singleton_set(Name,Set,Res) :-
1065		singleton_set(Set,El),
1066		detect_partial_records_for_field(Name),
1067		(El=(pred_true,El2)
1068		-> Val=El2 % TLA2B encoding for optional fields that are present
1069		; Val=El), % Alloy
1070		!,
1071		Res = Val.
1072		deconstruct_singleton_set(Name,[],Res) :-
1073		detect_partial_records_for_field(Name),
1074		Res = '$optional_field_absent'.
1075
1076		detect_partial_records_for_field(points) :- !, fail. % can be set of points
1077		detect_partial_records_for_field(children) :- !, fail. % children field for groups is a set of ids
1078		detect_partial_records_for_field(Name) :-
1079		is_svg_number_attribute(Name),!. % sets never sensible as a numerical value
1080		detect_partial_records_for_field(Name) :- is_id_or_text_attribute(Name),!. % ditto for ids
1081		detect_partial_records_for_field(Name) :- is_svg_color_attribute(Name),!. % ditto for colors
1082		detect_partial_records_for_field(_) :-
1083		\+ classical_b_mode. % TODO: check that we are in TLA or Alloy mode?
1084		% TODO: ensure ProB2 sets animation minor mode for TLA
1085
1086
1087		extract_attr_value(Name,Value,SVal,DefPos) :-
1088		is_svg_number_attribute(Name),!, % we could try and extract svg_class from attribute list above
1089		(get_number_from_bvalue(Value,NrVal)
1090		-> SVal=NrVal % convert to atom?
1091		; b_value_to_string(Value,SVal),
1092		(is_special_svg_number_form(SVal) -> true
1093		; atom_codes(SVal,CC),
1094		safe_number_codes(_NrVal,CC) -> true
1095		; ajoin(['The value of the SVG attribute "',Name,
1096		'" is not a number: '],Msg),
1097		add_warning(visb_visualiser,Msg,SVal,DefPos)
1098		)
1099		).
1100		extract_attr_value(children,Value,SVal,DefPos) :- !,
1101		(is_set_value(Value,extract_attr_value)
1102		-> (try_expand_custom_set_with_catch(Value,ExpandedSet,extract_attr_value),
1103		maplist(b_value_to_id_string,ExpandedSet,SVal) -> true
1104		; add_warning(visb_visualiser,'The children attribute should be a finite set of identifiers: ',Value,DefPos),
1105		SVal=[]
1106		)
1107		; add_warning(visb_visualiser,'The children attribute should be a set of identifiers: ',Value,DefPos),
1108		SVal=[]).
1109		extract_attr_value(points,Value,SVal,DefPos) :- % Class should be polygon or polyline
1110		% automatically translate sequences or sets of pairs of numbers to SVG string format
1111		(Value = [(Nr,_)|_] ; Value = avl_set(node((Nr,_),_,_,_,_))),
1112		is_number(Nr), % TODO: check typing
1113		svg_points(Value,Str,DefPos,no_wf_available),!,
1114		string(SVal)=Str.
1115		extract_attr_value(points,Value,SVal,_DefPos) :- Value = [],!, SVal = ''.
1116		extract_attr_value(visibility,Value,SVal,DefPos) :- !,
1117		% convert TRUE -> visible, FALSE -> hidden
1118		( Value=pred_true -> TxtVal='visible'
1119		; Value=pred_false -> TxtVal='hidden'
1120		; b_value_to_text_string(Value,TxtVal),
1121	?	(member(TxtVal,[collapse,hidden,visible]) -> true
1122		; add_warning(visb_visualiser,'Value of SVG attribute "visibility" must be collapse,hidden or visible and not: ',TxtVal,DefPos))
1123		),
1124		SVal=TxtVal.
1125		extract_attr_value(Name,Value,_,DefPos) :-
1126		check_svg_attribute_value(Name,Value,DefPos),fail.
1127		extract_attr_value(Name,Value,SVal,_) :-
1128	?	is_id_or_text_attribute(Name),!,
1129		(is_text_attribute(Name)
1130		-> b_value_to_text_string(Value,SVal)
1131		; b_value_to_id_string(Value,SVal)). % concatenates e.g. pairs of strings to string without ( |-> )
1132		extract_attr_value(Attr,RawValue,ResValue,_DefPos) :- raw_value_attribute(Attr),!, % keep value intact
1133		ResValue = RawValue.
1134		extract_attr_value(_Name,Value,SVal,_DefPos) :-
1135		b_value_to_string(Value,SVal).
1136
1137
1138		is_number(int(_)).
1139		is_number(term(floating(_))).
1140
1141		% do not convert to string; these are treated separately
1142		raw_value_attribute(hovers).
1143		raw_value_attribute(events).
1144
1145
1146		% evaluate a DEFINITION to a set of B records representing SVG objects
1147		% returns a possibly refined sub-position corresponding to generated SVG objects as last argument
1148		get_visb_DEFINITION_svg_object(SpecialClass,DefName,Body,_DefPos,ExpandedState,SVG_ID,AttrList,Desc,InnerPos) :-
1149		get_preference(visb_show_debug_infos,true),
1150		bsyntaxtree:is_eventb_comprehension_set(Body,Ids,Pred,Expr),
1151		% try and separate couple in Expr so that we have better position info for source of VISB_SVG_OBJECTS
1152		Body = b(_,Type,II),
1153		Expr = b(couple(_,_),_,_),
1154		!,
1155		couple_member(NewExpr,Expr), % evaluate each part of the couple in isolation, with better position info
1156		get_texpr_pos(NewExpr,InnerPos),
1157		b_ast_cleanup:rewrite_event_b_comprehension_set(Ids,NewExpr,Pred, Type, NewBody),
1158		get_visb_DEF_svg_object_aux(SpecialClass,DefName,b(NewBody,Type,II),InnerPos,ExpandedState,SVG_ID,AttrList,Desc).
1159		get_visb_DEFINITION_svg_object(SpecialClass,DefName,Body,DefPos,ExpandedState,SVG_ID,AttrList,Desc,DefPos) :-
1160	?	get_visb_DEF_svg_object_aux(SpecialClass,DefName,Body,DefPos,ExpandedState,SVG_ID,AttrList,Desc).
1161
1162		couple_member(TExpr,b(couple(A,B),_,_)) :- !, (couple_member(TExpr,A) ; couple_member(TExpr,B)).
1163		couple_member(TExpr,TExpr).
1164
1165		get_visb_DEF_svg_object_aux(SpecialClass,DefName,Body,DefPos,ExpandedState,SVG_ID,AttrList,Desc) :-
1166		evaluate_visb_formula(Body,DefName,'',ExpandedState,ResValue,DefPos),
1167		flex_expand(ResValue,DefName,DefPos,Expanded,[]),
1168		(Expanded = [] -> add_message(visb_visualiser,'Empty set of SVG object records: ',DefName,DefPos)
1169		; Expanded =[Record|_] ->
1170		(get_VISB_record_fields(Record,Fs)
1171		% TODO: as we now can have different type of records, check in flex_expand below
1172	?	-> (member(field(id,_),Fs)
1173		-> true
1174		; add_message(visb_visualiser,'DEFINITION needs an `id` field if you want to use updates: ',DefName,DefPos)
1175		)
1176		; ajoin(['DEFINITION ', DefName,' should evaluate to a set of records or tuples of records: '],Msg),
1177		add_warning(visb_visualiser,Msg,Record,DefPos)
1178		)
1179		),
1180	?	member(Records,Expanded),
1181		get_VISB_record_fields(Records,Fields),
1182	?	(select(field(id,VID),Fields,F1)
1183		-> extract_attribute_value(DefPos,id,VID,SVG_ID)
1184		; gensym(svg_id,SVG_ID), F1=Fields),
1185		(select(field(comment,CC),F1,F2), b_value_to_string(CC,Desc) -> true
1186		; Desc = '', F2=F1),
1187		(SpecialClass=visb_updates, member(field(visibility,VV),F2),
1188		is_invisible(VV),
1189		\+ visb_has_visibility_hover(SVG_ID) % check for hover which may make object visible
1190		-> AttrList=[svg_attribute(visibility,'hidden')] % do not transmit updates
1191		; include_maplist(extract_attribute_from_record(DefPos),F2,AttrList0),
1192		exclude(check_unsupported_special_visb_attribute(SpecialClass,DefPos),AttrList0,AttrList),
1193	?	(select(svg_attribute(svg_class,SVG_Class),AttrList,A2)
1194		-> maplist(check_attribute_is_supported(SVG_Class,DefPos),A2)
1195		; true)
1196		).
1197
1198		is_invisible(string(hidden)). % also treat collapse ?
1199		is_invisible(pred_false).
1200
1201		% expand nested tuples/sets to a single list of SVG records (possibly of different types)
1202		flex_expand(Value,DefName,Pos) --> {is_custom_explicit_set(Value)},!,
1203		{try_expand_custom_set_with_catch(Value,ExpandedSet,flex_expand),
1204		(is_custom_explicit_set(ExpandedSet)
1205		-> ajoin(['Could not expand set of SVG object records or tuples thereof for ',DefName,': '],Msg),
1206		add_warning(visb_visualiser,Msg,Value,Pos),
1207		fail
1208		; true)},
1209		flex_expand(ExpandedSet,DefName,Pos).
1210		flex_expand([],_,_) --> !, [].
1211		flex_expand(L,_DefName,_Pos) --> {L =[(string(_),string(_))|_]}, !,
1212		[L]. % is probably a partial function {"id" |-> ,...}
1213		flex_expand([H|T],DefName,Pos) --> !, flex_expand(H,DefName,Pos), l_flex_expand(T,DefName,Pos).
1214		flex_expand((A,B),DefName,Pos) --> !, flex_expand(A,DefName,Pos), flex_expand(B,DefName,Pos).
1215		flex_expand(T,_,_) --> [T].
1216
1217		l_flex_expand([],_,_) --> !, [].
1218		l_flex_expand([H|T],DefName,Pos) --> !, flex_expand(H,DefName,Pos), l_flex_expand(T,DefName,Pos).
1219		l_flex_expand(T,_,_) --> [T].
1220
1221		flex_member(X,SetPairVal,DefName,Pos) :- flex_expand(SetPairVal,DefName,Pos,List,[]), member(X,List).
1222
1223
1224		% get the fields of a B value record
1225		% also transparently handles alternative representations, like a function from STRING to STRING
1226		get_VISB_record_fields(rec(Fields),Res) :- !, Res=Fields.
1227		get_VISB_record_fields(StringFunction,Fields) :-
1228		is_set_value(StringFunction,get_VISB_record_fields),
1229		try_expand_custom_set_with_catch(StringFunction,Expanded,get_VISB_record_fields),
1230		% TODO: check we have no duplicates
1231		maplist(convert_to_field,Expanded,Fields).
1232		% TODO: support records as generated by READ_XML:
1233		% rec(attributes:{("fill"|->"#90ee90"),("height"|->"360px"),("id"|->"background_rect"),("width"|->"600px"),("x"|->"1px"),("y"|->"2px")},element:"rect",meta:{("xmlLineNumber"|->"3")},pId:5,recId:6)
1234		% for <rect height="360px" x="1px" y="2px" id="background_rect" width="600px" fill="#90ee90"></rect>
1235
1236		convert_to_field((string(FieldName),Value),field(FieldName,Value)).
1237		% TODO: maybe handle enumerated set values as field names
1238
1239
1240		% already extract and type-check VISB_SVG_UPDATES definitions
1241		precompile_svg_object_updates(ExpandedScope,JsonFileContext) :-
1242		b_sorted_b_definition_prefixed(expression,'VISB_SVG_UPDATES',DefName,DefPos),
1243		b_get_typed_definition(DefName,ExpandedScope,TypedExpr),
1244		assert_visb_udpate_def_body(visb_updates,DefName,TypedExpr,DefPos),
1245		add_children_for_visb_update_def_body(TypedExpr,DefName,JsonFileContext),
1246		fail.
1247		precompile_svg_object_updates(_,_).
1248
1249		% assert VisB updates or hovers from B DEFINITION,
1250		% either from VISB_SVG_UPDATES or hovers or dynamic parts of VISB_SVG_OBJECTS:
1251		assert_visb_udpate_def_body(_Kind,DefName,TypedExpr,_DefPos) :-
1252		TypedExpr=b(rec([field(id,_)]),_,Info),!, % can happen when all fields are static
1253		add_debug_message(visb_visualiser,'Useless update/hover (just id field): ',DefName,Info).
1254		assert_visb_udpate_def_body(Kind,DefName,b(couple(A,B),_,_),DefPos) :- !,
1255		% separate couples into individual expressions; in case of WD errors we have more localised errors/problems
1256		assert_visb_udpate_def_body(Kind,DefName,A,DefPos),
1257		assert_visb_udpate_def_body(Kind,DefName,B,DefPos).
1258		assert_visb_udpate_def_body(Kind,DefName,TypedExpr,DefPos) :-
1259		get_texpr_type(TypedExpr,Type),
1260		determine_type_of_visb_formula(TypedExpr,_,FormulaClass),
1261		debug_format(19,'Detected ~w: ~w (~w)~n',[Kind,DefName,FormulaClass]),
1262		assertz(visb_special_definition(Kind,DefName,Type,TypedExpr,FormulaClass,DefPos)),
1263		check_visb_update_type(Kind,Type,DefName,unknown_svg_class,DefPos),
1264		static_check_dynamic_update_def_body(TypedExpr).
1265
1266
1267		% check if we need to add virtual children for an VISB_SVG_UPDATES body:
1268		% (e.g., for title updates to SVG objects coming from an SVG file)
1269		add_children_for_visb_update_def_body(b(couple(A,B),_,_),DefName,JsonFile) :- !,
1270		(add_children_for_visb_update_def_body(A,DefName,JsonFile)
1271		;
1272		add_children_for_visb_update_def_body(B,DefName,JsonFile)).
1273		add_children_for_visb_update_def_body(b(rec(Fields),_,_),DefName,JsonFile) :-
1274		select(field(id,TParentId),Fields,F2),!,
1275		is_static_expr(TParentId,id,DefName), % we need a static value to create children for it
1276		TParentId = b(_,_,Info),
1277		evaluate_static_visb_formula(TParentId,DefName,'',[],ResValue,Info),
1278		b_value_to_id_string(ResValue,ParentId),
1279		\+ svg_id_exists(ParentId),
1280		(\+ get_default_visb_svg_file(_,_), % cannot call no_svg_file_available yet
1281		JsonFile = '', % No JSON file to be loaded after, which could add SVG file or objects
1282		\+ special_definition_exists('VISB_SVG_CONTENTS')
1283		-> ajoin(['Unknown VISB_SVG_OBJECT with id ',ParentId,' in: '],Msg),
1284		add_warning(visb_visualiser,Msg,DefName,Info)
1285		; select(field(title,TTitle),F2,_),
1286		(TTitle = b(string(Title),_,_) -> true ; Title = 'no-title-set'),
1287		get_texpr_pos(TTitle,Pos),
1288		add_virtual_title_object(Title,DefName,Pos,TitleID),
1289		assert_visb_svg_child(ParentId,Pos,TitleID),
1290		assert(visb_svg_child_of_object_from_svg_file(TitleID))
1291		),
1292		fail.
1293		% TODO: set comprehensions like {x•x:Obj|rec(id=("obj",x), title=....)}
1294		% TODO: support sets and warn when ID is not statically known?
1295
1296		% assert VisB events or hovers from B DEFINITION, from part of VISB_SVG_OBJECTS:
1297		% supporting event: attribute and optional predicate attribute
1298		% Kind = visb_events %or visb_hovers
1299		add_visb_events_from_def_body(Kind,DefName,Body,DefPos) :-
1300		get_texpr_type(Body,Type),
1301		\+ empty_update_or_hover_type(Type), % at least one more field than just id field
1302		get_visb_static_svg_object_for_typed_expr(Kind,DefName,Body,DefPos,SVG_ID,AttrList,Desc,InnerPos),
1303		add_visb_object_from_definition(Kind, SVG_ID, AttrList, Desc, DefName, InnerPos),
1304		fail.
1305		add_visb_events_from_def_body(_,_,_,_).
1306
1307		empty_update_or_hover_type(record(Fields)) :- !, Fields \= [_,_|_]. % at least one more field than just id field
1308		empty_update_or_hover_type(set(X)) :- !, empty_update_or_hover_type(X).
1309		empty_update_or_hover_type(couple(A,B)) :- !, empty_update_or_hover_type(A), empty_update_or_hover_type(B).
1310
1311		get_svg_object_updates_from_definitions(ExpandedBState,SVG_ID,SvgAttribute,Value,Pos) :-
1312	?	visb_special_definition(visb_updates,DefName,_Type,BodyTypedExpr,_Class,DefPos),
1313	?	get_visb_DEFINITION_svg_object(visb_updates,DefName,BodyTypedExpr,DefPos,ExpandedBState,SVG_ID,AttrList,_Desc,Pos),
1314	?	member(svg_attribute(SvgAttribute,Value),AttrList).
1315
1316		% check types of VisB updates
1317		check_visb_update_type(Kind,Type,DefName,Class,DefPos) :-
1318		get_update_record_fields_type(Type,Fields),
1319		% other types are STRING +-> STRING, ...; this will be checked in get_visb_DEFINITION_svg_object
1320		(memberchk(field('svg_class',_),Fields)
1321		-> add_warning(visb_visualiser,'VisB updates should not set svg_class:',DefName,DefPos)
1322		; true),
1323	?	member(field(Name,FieldType),Fields),
1324		(Name = trigger_id ->
1325		(Kind=visb_hovers -> true ;
1326		add_warning(visb_visualiser,'Attribute trigger_id can only be used for hovers:',DefName,DefPos)
1327		)
1328		; check_attribute_type(FieldType,Name,DefName,Class,DefPos)
1329		),
1330		fail.
1331		check_visb_update_type(_,_,_,_,_).
1332
1333		% get a fields type list from a type
1334		get_update_record_fields_type(set(X),Fields) :- !,
1335		get_update_record_fields_type(X,Fields).
1336		get_update_record_fields_type(record(Fields),R) :- !, R=Fields.
1337		get_update_record_fields_type(couple(A,B),Fields) :-
1338		(get_update_record_fields_type(A,Fields)
1339		; get_update_record_fields_type(B,Fields)).
1340
1341
1342		% check B type of a field for an SVG update or object
1343		check_attribute_type(Type,Name,DefName,Class,DefPos) :- alternative_spelling(Name,AName),!,
1344		check_attribute_type(Type,AName,DefName,Class,DefPos).
1345		check_attribute_type(Type,Name,DefName,Class,DefPos) :- Class \= unknown_svg_class,
1346		check_is_number_attribute(Name,Class,DefPos),!,
1347		illegal_number_type(Type),
1348		ajoin(['Type of field ',Name,' of ', DefName, ' is not a number: '],Msg),
1349		pretty_type(Type,TS),
1350		add_warning(visb_visualiser,Msg,TS,DefPos).
1351		check_attribute_type(Type,Name,DefName,_,DefPos) :-
1352		is_svg_color_attribute(Name),!,
1353		illegal_col_type(Type),
1354		ajoin(['Type of field ',Name,' of ', DefName, ' is not a color: '],Msg),
1355		pretty_type(Type,TS),
1356		add_warning(visb_visualiser,Msg,TS,DefPos).
1357		check_attribute_type(_Type,Name,_DefName,Class,DefPos) :-
1358		check_attribute_name_is_supported(Class,Name,DefPos).
1359
1360		illegal_nr_or_col_type(boolean).
1361		illegal_nr_or_col_type(set(_)).
1362		illegal_nr_or_col_type(seq(_)).
1363		illegal_nr_or_col_type(record(_)).
1364		illegal_nr_or_col_type(couple(A,B)) :- (illegal_nr_or_col_type(A) -> true ; illegal_nr_or_col_type(B)).
1365		% check if couple types can work by concatenating string representations
1366
1367		illegal_col_type(X) :- illegal_nr_or_col_type(X),!.
1368		illegal_col_type(real).
1369		% integer ? or can we map integers to colours using a color scheme like in DOT?
1370
1371		illegal_number_type(X) :- illegal_nr_or_col_type(X),!.
1372		%illegal_number_type(global(_)). % what if we use a global set with weird constants using back-quotes ?
1373
1374		% ----------------
1375
1376		% parse and load an individual JSON VisB item, e.g, :
1377		% { "name":"xscale",
1378		% "value" : "(100.0 / real(TrackElementNumber))"
1379		% }
1380
1381		process_json_definition(File,json(List)) :-
1382		(get_attr_true(ignore,List,File) -> true % ignore this definition
1383		; process_json_def_lst(File,List)).
1384
1385
1386		process_json_def_lst(File,List) :-
1387		force_del_attr_with_pos(name,List,string(ID),L1,File,NamePos),
1388		force_del_attr_with_pos(value,L1,string(Formula),L2,File,VPos),
1389		debug_format(19,' Processing definition for ~w with value-formula (lines ~w):~w~n',[ID,VPos,Formula]),
1390		!,
1391		set_gen_parse_errors(L2,VPos,GenParseErrors), % treat optional attribute
1392		process_json_definition(ID,NamePos,Formula,VPos,GenParseErrors).
1393		process_json_def_lst(File,List) :- get_pos_from_list(List,File,Pos),
1394		add_error(visb_visualiser,'Illegal VisB Definition:',List,Pos).
1395
1396		% we could also load a classical B Definition file and process its definitions like this:
1397		process_json_definition(ID,NamePos,Formula,VPos,GenParseErrors) :-
1398		atom_codes(Formula,FCodes),
1399		set_error_context(visb_error_context(definition,ID,'value',VPos)),
1400		(b_get_definition_name_with_pos(ID,_Arity,_DefType,_DPos)
1401		-> add_warning(visb_visualiser,'Ignoring VisB definition, DEFINITION of the same name already exists:',ID,NamePos)
1402		; parse_expr(FCodes,TypedExpr,GenParseErrors)
1403		-> add_visb_json_definition(ID,TypedExpr,VPos)
1404		; GenParseErrors=false -> formatsilent('Ignoring optional VisB definition for ~w due to error in B formula~n',[ID])
1405		; add_error(visb_visualiser,'Cannot parse or typecheck VisB formula for definition',ID,VPos)
1406		),
1407		clear_error_context.
1408
1409		add_visb_json_definition(ID,TypedExpr,VPos) :-
1410		get_texpr_type(TypedExpr,Type),
1411		determine_type_of_visb_formula(TypedExpr,TIds,Class), %write(type(ID,Class,TIds)),nl,
1412		(try_eval_static_def(Class,'static definition', ID,TypedExpr,TIds,StaticValue,VPos)
1413		-> get_texpr_type(TypedExpr,Type),StaticValueExpr = b(value(StaticValue),Type,[]),
1414		assert_visb_json_definition(ID,Type,StaticValueExpr,TIds,Class,VPos)
1415		; assert_visb_json_definition(ID,Type,TypedExpr,TIds,Class,VPos)
1416		).
1417
1418		% assert a VisB definition stemming from the JSON definitions section:
1419		assert_visb_json_definition(DefName,Type,TypedExpr,UsedTIds,Class,DefPos) :-
1420	?	(is_special_visb_def_name(DefName,SpecialClass) -> true ; SpecialClass = regular_def),
1421		assertz(visb_definition(DefName,Type,TypedExpr,Class,DefPos,SpecialClass)),
1422		(SpecialClass \= regular_def
1423		-> formatsilent('Detected special ~w definition ~w (~w)~n',[SpecialClass,DefName,Class]),
1424		add_special_json_definition(SpecialClass,DefName,Type,TypedExpr,UsedTIds,Class,DefPos)
1425		; true
1426		).
1427
1428		% register some special definitions, in which a set of objects/hovers/updates can be specified
1429		% by a single definition returning a set of records
1430		add_special_json_definition(visb_updates,DefName,Type,TypedExpr,_,Class,DefPos) :- !,
1431		check_visb_update_type(visb_updates,Type,DefName,Class,DefPos),
1432		assertz(visb_special_definition(visb_updates,DefName,Type,TypedExpr,Class,DefPos)). % will be evaluated later
1433		add_special_json_definition(visb_contents,DefName,Type,TypedExpr,_,Class,DefPos) :- !,
1434		assertz(visb_special_definition(visb_contents,DefName,Type,TypedExpr,Class,DefPos)).
1435		add_special_json_definition(visb_box,DefName,Type,TypedExpr,_,Class,DefPos) :- !,
1436		assertz(visb_special_definition(visb_box,DefName,Type,TypedExpr,Class,DefPos)).
1437		add_special_json_definition(visb_objects,DefName,_Type,TypedExpr,_UsedTIds,_Class,DefPos) :- !,
1438		AllowSep=allow_separation, % TODO: we re-determine the class and used ids below:
1439		get_typed_static_definition_with_constants_state(DefName,TypedExpr,ResBody,DefPos,CS,no_inlining,AllowSep),
1440		(get_visb_DEFINITION_svg_object(visb_objects,DefName,ResBody,DefPos,CS,SVG_ID,AttrList,Desc,InnerPos),
1441		%formatsilent('Adding ~w : ~w (from ~w)~n',[visb_objects,SVG_ID,DefName]),
1442		add_visb_object_from_definition(visb_objects, SVG_ID, AttrList, Desc, DefName, InnerPos),
1443		fail ; true).
1444		add_special_json_definition(SpecialClass,DefName,_Type,TypedExpr,UsedTIds,Class,DefPos) :-
1445		(get_unique_initial_state_for_visb(Class,DefName,DefPos,UsedTIds,ConstantsState) -> true
1446		; ConstantsState=[]),
1447		get_static_visb_state(ConstantsState,FullState), % add static VisB Defs
1448		(Class=requires_variables,
1449		(get_preference(visb_allow_variables_for_objects,false) ; ConstantsState=[])
1450		-> add_warning(visb_visualiser,'Ignoring VisB definition which requires variables:',DefName,DefPos)
1451		; get_visb_DEFINITION_svg_object(SpecialClass,DefName,TypedExpr,DefPos,FullState,SVG_ID,AttrList,Desc,InnerPos),
1452		%formatsilent('Adding ~w : ~w (from ~w)~n',[SpecialClass,SVG_ID,DefName]),
1453		add_visb_object_from_definition(SpecialClass, SVG_ID, AttrList, Desc, DefName, InnerPos)
1454		; true).
1455
1456		is_special_visb_def_name(DefName,visb_updates) :- atom_concat('VISB_SVG_UPDATES',_,DefName).
1457		is_special_visb_def_name(DefName,visb_hovers) :- atom_concat('VISB_SVG_HOVERS',_,DefName).
1458		is_special_visb_def_name(DefName,visb_objects) :- atom_concat('VISB_SVG_OBJECTS',_,DefName).
1459		is_special_visb_def_name(DefName,visb_contents) :- atom_concat('VISB_SVG_CONTENTS',_,DefName).
1460		is_special_visb_def_name(DefName,visb_events) :- atom_concat('VISB_SVG_EVENTS',_,DefName).
1461		is_special_visb_def_name('VISB_SVG_BOX',visb_box).
1462		% TODO: maybe provide VISB_HTML_CONTENTS which appear after the SVG
1463
1464		% evaluate static VisB defs only once or evaluate expressions in svg_objects and loop bounds
1465		eval_static_def(Class,VisBKind,ID,TypedExpr,UsedTIds,StaticValue,VPos) :-
1466		get_unique_initial_state_for_visb(Class,ID,VPos,UsedTIds,ConstantsState),
1467		evaluate_static_visb_formula(TypedExpr,VisBKind,ID,ConstantsState,StaticValue,VPos).
1468
1469		% only evaluate statically if possible; no warnings/messages if not possible (just fail)
1470		try_eval_static_def(requires_variables,_VisBKind,_ID,_TypedExpr,_UsedTIds,_StaticValue,_VPos) :- !,
1471		fail. % do not try to evaluate statically; events will change the variable values anyway
1472		try_eval_static_def(Class,VisBKind,ID,TypedExpr,UsedTIds,StaticValue,VPos) :-
1473		% TODO: disable messages for multiple constants values; just fail
1474		eval_static_def(Class,VisBKind,ID,TypedExpr,UsedTIds,StaticValue,VPos).
1475
1476		% check if a unique constant value exists for a model
1477		get_unique_initial_state_for_visb(requires_nothing,_,_,_,State) :- !, State=[].
1478		get_unique_initial_state_for_visb(Class,DefName,DefPos,_,State) :-
1479		\+ multiple_concrete_constants_exist,
1480		is_concrete_constants_state_id(StateID),!,
1481		(Class=requires_variables
1482		-> get_preference(visb_allow_variables_for_objects,true),
1483		unique_initialisation_id_exists_from(StateID,DefName,DefPos,State)
1484		% Note: variable can still be modified by other events later, e.g., in ProB2-UI
1485		; visited_expression(StateID,StateTerm),
1486		state_corresponds_to_set_up_constants_only(StateTerm,State)).
1487		get_unique_initial_state_for_visb(requires_constants,DefName,DefPos,Ids,State) :- Ids \= all,
1488		% try and see if all values for Ids are the same; TODO: also support requires_variables
1489		is_concrete_constants_state_id(StateID),!,
1490		visited_expression(StateID,StateTerm),
1491		state_corresponds_to_set_up_constants_only(StateTerm,State),
1492		(member(C,Ids), get_texpr_id(C,CstID),
1493		other_constant_value_exists_for(CstID,State,StateID)
1494		-> ajoin(['Multiple values for constant ',CstID, ' in context of'],Msg),
1495		add_visb_lint_message(Msg,DefName,DefPos),fail
1496		; true).
1497
1498
1499		get_a_constants_state(State,StateID,inline_objects(SingleStateId)) :-
1500		get_constants_state_id_for_id(SingleStateId,StateID),!,
1501		visited_expression(StateID,StateTerm),
1502		state_corresponds_to_set_up_constants_only(StateTerm,State).
1503		get_a_constants_state(State,StateID,InlineObjects) :-
1504		check_inlining(InlineObjects),
1505		is_concrete_constants_state_id(StateID),!,
1506		visited_expression(StateID,StateTerm),
1507		state_corresponds_to_set_up_constants_only(StateTerm,State).
1508
1509		check_inlining(no_inlining) :- !.
1510		check_inlining(inline_objects(_SingleStateId)) :- !.
1511		check_inlining(X) :- add_internal_error('Invalid inlining value:',check_inlining(X)).
1512
1513
1514		other_constant_value_exists_for(CstID,State,StateId) :-
1515		lookup_value_for_existing_id(CstID,State,Val1),
1516		is_concrete_constants_state_id(StateId2), StateId2 \= StateId,
1517		visited_expression(StateId2,StateTerm2),
1518		state_corresponds_to_set_up_constants_only(StateTerm2,State2),
1519		lookup_value_for_existing_id(CstID,State2,Val2),
1520		Val2 \= Val1.
1521
1522
1523		unique_initialisation_id_exists_from(FromStateId,DefName,DefPos,State) :-
1524		transition(FromStateId,_,StateID),!,
1525		(transition(FromStateId,_,StateID2),
1526		StateID2 \= StateID
1527		-> ajoin(['Multiple initialisations exists (state ids ',StateID,',',StateID2,') for'],Msg),
1528		add_visb_lint_message(Msg,DefName,DefPos),fail
1529		; true),
1530		visited_expression(StateID,StateTerm),
1531		state_corresponds_to_initialised_b_machine(StateTerm,State).
1532
1533		parse_expr_for_visb(Formula,JsonList,Pos,TypedExpr) :-
1534		set_gen_parse_errors(JsonList,Pos,GenParseErrors),
1535		parse_expr(Formula,TypedExpr,GenParseErrors).
1536
1537		set_gen_parse_errors(JSonList,Pos,GenParseErrors) :-
1538		(get_attr(optional,JSonList,_)
1539		-> GenParseErrors=false
1540		; %get_pos_from_list(JSonList,File,Position),
1541		GenParseErrors=gen_parse_errors_for(Pos)).
1542
1543		% ----------------
1544
1545		% parse and load an individual JSON SVG object listed under svg_objects, e.g, :
1546		% {
1547		% "svg_class":"rect",
1548		% "id":"train_rect",
1549		% "x":"0",
1550		% "y":"0",
1551		% "comment":"..."
1552		% },
1553		process_json_svg_object(File,Json) :-
1554		process_repeat(0,Json,File,add_visb_json_svg_object).
1555
1556		add_visb_json_svg_object(File,json(List)) :- get_attr_true(ignore,List,File), !. % ignore this item
1557		add_visb_json_svg_object(File,json(List)) :-
1558		(force_del_attr_with_pos(svg_class,List,string(SVG_Class),L1,File,Pos1) -> true % shape: line, rect, ...
1559		; infer_svg_class(List,SVG_Class,File,Pos1)
1560		-> add_visb_lint_message('Inferred svg_class',SVG_Class,Pos1),L1=List),
1561		force_del_attr(id,L1,string(ID),L2,File),
1562		(del_attr(comment,L2,string(Desc),JsonList3) -> true ; Desc = '', JsonList3=L2),
1563		debug_format(19,' Creating new SVG object ~w with id:~w~n',[SVG_Class,ID]),
1564		add_debug_message(visb_visualiser,'New object: ',ID,Pos1),
1565		% TODO: we could pre-process all attributes not depending on %0, %1, ...
1566		maplist(get_svg_attr(SVG_Class,File),JsonList3,AttrList),
1567		%formatsilent('Adding SVG Object ~w with ID ~w (~w): ~w~n',[SVG_Class,ID,Desc,AttrList]),
1568		assert_visb_svg_object(ID,SVG_Class,AttrList,Desc,'JSON',Pos1),
1569		!.
1570		add_visb_json_svg_object(File,Json) :-
1571		!,
1572		get_pos_from_list(Json,File,Pos),
1573		add_error(visb_visualiser,'Illegal VisB additional SVG object:',Json,Pos).
1574
1575		infer_svg_class(List,line,File,Pos) :- get_attr_with_pos(x1,List,_,File,Pos),!.
1576		infer_svg_class(List,circle,File,Pos) :- get_attr_with_pos(r,List,_,File,Pos),!.
1577		infer_svg_class(List,rect,File,Pos) :- get_attr_with_pos(height,List,_,File,Pos),!.
1578		infer_svg_class(List,rect,File,Pos) :- get_attr_with_pos(width,List,_,File,Pos),!.
1579		infer_svg_class(List,ellipse,File,Pos) :- get_attr_with_pos(rx,List,_,File,Pos),!. % could also be rect
1580		infer_svg_class(List,text,File,Pos) :- get_attr_with_pos(text,List,_,File,Pos),!.
1581		infer_svg_class(List,g,File,Pos) :- get_attr_with_pos(children,List,_,File,Pos),!. % group + foreignObject have children
1582		infer_svg_class(List,use,File,Pos) :- get_attr_with_pos(href,List,_,File,Pos),!. % href can also be used with image, pattern, ...
1583
1584		% assert a new SVG object to be created upon SETUP_CONSTANTS/INITIALISATION:
1585		assert_visb_svg_object(ID,SVG_Class,_AttrList,_Desc,DefName,Pos1) :-
1586		visb_svg_object(ID,_,_,_,_Pos0),!,
1587		ajoin(['SVG object (from ',DefName,', svg_class=',SVG_Class,') with same id already created: '],Msg),
1588		add_warning(visb_visualiser,Msg,ID,Pos1).
1589		assert_visb_svg_object(_ID,_SVG_Class,AttrList,_Desc,_DefName,Pos1) :-
1590		\+ (AttrList=[] ; AttrList=[_|_]),!,
1591		add_error(visb_visualiser,'SVG objects attributes are not a list:',AttrList,Pos1).
1592		assert_visb_svg_object(ID,SVG_Class,AttrList,Desc,DefName,Pos1) :-
1593		check_svg_shape_class(ID,SVG_Class,Pos1),
1594		add_visb_debug_infos(ID,SVG_Class,AttrList,AttrList2,DefName,Pos1),
1595		sort(AttrList2,SAttrList),
1596		get_all_children(SAttrList,Children,RestAttrs,DefName,Pos1),
1597		(Children = [] -> true
1598	?	; svg_shape_can_have_children(SVG_Class) -> true % g, foreignObject, symbol, HTML tags
1599		; Children = [C1_ID|_], visb_svg_object(C1_ID,CAttr,_,_,_),
1600		attribute_automatically_creates_children(CAttr) % e.g., title object created for title attribute of ID
1601		-> true
1602		; add_visb_lint_message('Children attribute only useful for certain SVG classes such as groups (g) or foreignObject or when adding title objects (as tooltips)',Children,Pos1)
1603		),
1604	?	(select(svg_attribute(group_id,ParentGroupId),RestAttrs,RestAttrs2)
1605		-> assert_visb_svg_child(ParentGroupId,Pos1,ID) % register parent group id
1606		; RestAttrs2=RestAttrs),
1607		compute_auto_attributes(RestAttrs,RestAttrs2,SVG_Class,NewRestAttrs),
1608		assertz(visb_svg_object(ID,SVG_Class,NewRestAttrs,Desc,Pos1)),
1609		maplist(assert_visb_svg_child(ID,Pos1),Children). % add all children
1610
1611		% adapt visb_svg_object to provide developer debug infos, e.g., in title hover messages
1612		add_visb_debug_infos(ID,SVG_Class,AttrList,NewAttrList,DefName,Pos) :- SVG_Class \= title,
1613		get_preference(visb_show_debug_infos,true),
1614		(select(svg_attribute(title,Title),AttrList,RestAttrs) -> true
1615		; Title='', RestAttrs=AttrList),
1616		!,
1617		extract_span_description_with_opts(Pos,PosStr,
1618		[relative_file_name,compact_pos_info,
1619		inner_context_separator('\n in ','\n at ')]),
1620		%extract_definition_call_stack_desc(Pos,CS), already displayed in inner context
1621		ajoin(['-- VISB_DEBUG_INFO --\nid=',ID, '\nsvg_class=',SVG_Class, '\nsrc=',DefName,'\n', PosStr],DebugInfo),
1622		(Title='' -> NewTitle=DebugInfo ; ajoin([Title,'\n',DebugInfo],NewTitle)),
1623		%format('~nDEBUG::~n~w~n~w~n---~n',[ID,DebugInfo]),
1624		assert(visb_svg_object_debug_info(ID,DebugInfo)),
1625		NewAttrList = [svg_attribute(title,NewTitle)|RestAttrs].
1626		add_visb_debug_infos(_,_,AttrList,AttrList,_,_).
1627
1628		% compute the value of VisB auto attributes, e.g., automatically
1629		% doing a layout of objects in a grid
1630		% TODO: SVG/special_svg_number already supports auto but not for x,y coordinates?
1631		% TODO: try and determine width of object automatically; keep track of auto objects max height per row
1632		% TODO: support cx,cy
1633		compute_auto_attributes([],_,_,[]).
1634		compute_auto_attributes([svg_attribute(Attr,Val)|T],AllAttrs,SVG_Class,
1635		[svg_attribute(Attr,NewVal)|NT]) :-
1636		(Val=auto, compute_auto_attribute(Attr,AllAttrs,SVG_Class,NewVal)
1637		-> true
1638		; NewVal=Val),
1639		compute_auto_attributes(T,AllAttrs,SVG_Class,NT).
1640
1641		:- dynamic next_auto_x/1, next_auto_y/2.
1642		next_auto_x(0).
1643		next_auto_y(0,10).
1644		reset_auto_attrs :- retractall(next_auto_x(_)),
1645		retractall(next_auto_y(_,_)),
1646		assertz(next_auto_x(0)),
1647		assertz(next_auto_y(0,10)).
1648
1649		get_x_auto_limit(Limit) :- visb_empty_svg_box_height_width(_H,W,_ViewBox),!,
1650		Limit = W. %TODO: inspect viewBox
1651		get_x_auto_limit(400).
1652
1653		compute_auto_attribute(id,_,_,GenID) :- !, gensym(svg_id,GenID).
1654		compute_auto_attribute(Attr,AllAttrs,SVG_Class,Val) :-
1655		auto_compute_x_coordinate(Attr,Kind),!,
1656		retract(next_auto_x(XV)),
1657		(get_width(SVG_Class,AllAttrs,Offset) -> true ; Offset=10),
1658		Padding = 2, % TODO: make customisable
1659		NewXV is XV+Offset+Padding,
1660		get_x_auto_limit(Lim),
1661		(NewXV > Lim
1662		-> NewVal=0, retract(next_auto_y(OldY,YOffset)),
1663		(get_height(SVG_Class,AllAttrs,Offset) -> true ; Offset = 10),
1664		NewY is OldY+YOffset,
1665		assert(next_auto_y(NewY,YOffset))
1666		; NewVal=NewXV),
1667		assertz(next_auto_x(NewVal)),
1668		(Kind=left -> Val=XV ; Val is XV + Offset/2).
1669		compute_auto_attribute(Attr,AllAttrs,SVG_Class,Val) :- auto_compute_y_coordinate(Attr,Kind),
1670		next_auto_y(YV,_),
1671		(Kind = top -> Val = YV
1672		; get_height(SVG_Class,AllAttrs,Height) -> Val is YV + Height/2
1673		; Val is YV+5).
1674
1675		auto_compute_x_coordinate(x,left). % rect, ..
1676		auto_compute_x_coordinate(cx,center). % circle, ellipse
1677		auto_compute_y_coordinate(y,top). % rect, ..
1678		auto_compute_y_coordinate(cy,center). % circle, ellipse
1679
1680		get_width(rect,Attrs,Wid) :- member(svg_attribute(width,Wid),Attrs).
1681		get_width(circle,Attrs,Wid) :- member(svg_attribute(r,Radius),Attrs), Wid is 2*Radius.
1682		get_width(ellipse,Attrs,Wid) :- member(svg_attribute(rx,Radius),Attrs), Wid is 2*Radius.
1683		get_width(line,Attrs,Wid) :- member(svg_attribute(x1,X1),Attrs),
1684		member(svg_attribute(x2,X2),Attrs), Wid is abs(X2-X1).
1685
1686		get_height(rect,Attrs,Wid) :- member(svg_attribute(height,Wid),Attrs).
1687		get_height(circle,Attrs,Wid) :- member(svg_attribute(r,Radius),Attrs), Wid is 2*Radius.
1688		get_height(ellipse,Attrs,Wid) :- member(svg_attribute(ry,Radius),Attrs), Wid is 2*Radius.
1689		get_height(line,Attrs,Wid) :- member(svg_attribute(y1,X1),Attrs),
1690		member(svg_attribute(y2,X2),Attrs), Wid is abs(X2-X1).
1691
1692
1693		% register an SVG ID as child of a group
1694		assert_visb_svg_child(_ParentId,Pos,ChildID) :- visb_svg_child(ChildID,OldParent),!,
1695		ajoin(['SVG object already child of group ',OldParent,': '],Msg),
1696		add_warning(visb_visualiser,Msg,ChildID,Pos).
1697		assert_visb_svg_child(ParentId,Pos,ChildID) :- visb_svg_child(ParentId,ChildID),!, % TODO: full cycle detection
1698		ajoin(['SVG object already parent of group ',ParentId,' (cycle): '],Msg),
1699		add_warning(visb_visualiser,Msg,ChildID,Pos).
1700		assert_visb_svg_child(ParentId,_Pos,ChildID) :-
1701		assertz(visb_svg_child(ChildID,ParentId)),
1702		assertz(visb_svg_parent(ParentId,ChildID)).
1703
1704
1705		% we need to translate a title attribute to a separate title object and add it as a child
1706		% see also post_process_visb_item which dispatches title updates to the child object
1707		get_all_children(SAttrList,Children,Rest,DefName,Pos) :-
1708	?	select(svg_attribute(title,Title),SAttrList,SList2),!,
1709		add_virtual_title_object(Title,DefName,Pos,TitleID),
1710		Children=[TitleID|TChilds],
1711		get_children_attribute(SList2,TChilds,Rest,Pos).
1712		get_all_children(SAttrList,Children,Rest,_,Pos) :-
1713		% get the children explicitly defined by the user:
1714		get_children_attribute(SAttrList,Children,Rest,Pos).
1715
1716		add_virtual_title_object(Title,DefName,Pos,TitleID) :-
1717		gensym(visb_title,TitleID),
1718		assert_visb_svg_object(TitleID,'title',[svg_attribute(text,Title)],'',DefName,Pos),
1719		add_debug_message(visb_visualiser,'Adding virtual title child object: ',TitleID,Pos).
1720
1721		get_children_attribute(SAttrList,Children,Rest,Pos) :-
1722	?	select(svg_attribute(children,C),SAttrList,R),!,
1723		(is_list(C) -> Children=C
1724		; add_warning(visb_visualiser,'Children attribute should be a list (of SVG ids): ',C,Pos),
1725		Children=[]),
1726		Rest=R.
1727		get_children_attribute(SAttrList,[],SAttrList,_).
1728
1729
1730		svg_shape_can_have_children(defs).
1731		svg_shape_can_have_children(foreignObject).
1732		svg_shape_can_have_children(g).
1733		svg_shape_can_have_children(pattern).
1734		svg_shape_can_have_children(symbol).
1735		svg_shape_can_have_children(X) :- is_html_tag(X).
1736
1737
1738		% check whether svg_class value seems valid
1739		check_svg_shape_class(ID,Shape,Pos) :-
1740		(is_svg_shape_class(Shape) -> true
1741		; is_html_tag(Shape) ->
1742		(visb_svg_child(ID,ParentId),
1743		visb_svg_object(ParentId,ParClass,_,_,_),
1744		(is_html_tag(ParClass) -> true ; ParClass=foreignObject)
1745		-> add_debug_message(visb_visualiser,'HTML tag used as svg_class in foreignObject child: ',Shape,Pos)
1746		; ajoin(['SVG object ', ID, ' has HTML tag as svg_class (and should probably be a child of a foreignObject)'],Msg),
1747		add_visb_lint_message(Msg,Shape,Pos) % probably should be child of foreignObject
1748		)
1749		; dotshape2svg_class(Shape,Class)
1750		-> ajoin(['SVG object ', ID, ' has unknown svg_class (did you mean ',Class,' ?): '],Msg),
1751		add_warning(visb_visualiser,Msg,Shape,Pos)
1752		; get_all_svg_classes(Classes),
1753		get_possible_fuzzy_matches_and_completions_msg(Shape,Classes,FMsg)
1754		-> ajoin(['SVG object ', ID, ' has unknown svg_class (did you mean ',FMsg,' ?): '],Msg),
1755		add_warning(visb_visualiser,Msg,Shape,Pos)
1756		; ajoin(['SVG object ', ID, ' has unknown svg_class'],Msg),
1757		add_visb_lint_message(Msg,Shape,Pos)
1758		).
1759
1760		% get SVG attribute for an svg_object:
1761		get_svg_attr(SVG_Class,File,'='(Attr,AttrVal,Pos),svg_attribute(Attr,Val)) :- !,
1762		construct_prob_pos_term(Pos,File,PosTerm),
1763		get_svg_static_attribute_value(Attr,SVG_Class,PosTerm,AttrVal,Val).
1764		get_svg_attr(_,File,Json,_) :-
1765		get_pos_from_list([Json],File,Position),
1766		add_error(visb_visualiser,'Illegal SVG object attribute',Json,Position),fail.
1767
1768		get_svg_static_attribute_value(Attr,SVG_Class,Pos,AttrVal,Nr) :-
1769		check_is_number_attribute(Attr,SVG_Class,Pos),
1770		\+ is_special_svg_number_form(AttrVal),
1771		!,
1772		(get_number_value(AttrVal,Nr,Attr,Pos) -> true
1773		; add_error(visb_visualiser,'Illegal number value:',AttrVal,Pos), Nr=0).
1774		get_svg_static_attribute_value(_,_,_,string(Val),Res) :- !, Res=Val.
1775		% for children we get something like array([string(button1_1),string(button1_2)])
1776		get_svg_static_attribute_value(Attr,SVG_Class,Pos,array(List),ResList) :- !,
1777		maplist(get_svg_static_attribute_value(Attr,SVG_Class,Pos),List,ResList).
1778		get_svg_static_attribute_value(_Attr,_,Pos,Val,Val) :-
1779		add_warning(visb_visualiser,'Illegal SVG object attribute value: ',Val,Pos).
1780
1781
1782		% detect special SVG number forms, like 50%
1783		is_special_svg_number_form(string(Atom)) :-
1784		atom_codes(Atom,Codes),
1785		special_svg_number(Codes,[]).
1786
1787
1788		:- assert_must_succeed(visb_visualiser:special_svg_number("10%",[])).
1789		:- assert_must_succeed(visb_visualiser:special_svg_number("10 %",[])).
1790		:- assert_must_succeed(visb_visualiser:special_svg_number(" 99em ",[])).
1791		:- assert_must_succeed(visb_visualiser:special_svg_number("1.0em",[])).
1792		:- assert_must_fail(visb_visualiser:special_svg_number("10",[])).
1793		:- assert_must_fail(visb_visualiser:special_svg_number("10+nrcols+%0",[])).
1794		special_svg_number --> " ",!, special_svg_number.
1795		special_svg_number --> [X], {digit(X)},!, special_svg_number2.
1796		special_svg_number --> "auto".
1797		special_svg_number2 --> [X], {digit(X)},!, special_svg_number2.
1798		special_svg_number2 --> ".",!, special_svg_number2. % TODO: only allow one dot; + accept e notation?
1799		special_svg_number2 --> optws,!, svg_unit,!, optws.
1800
1801		% using info from https://oreillymedia.github.io/Using_SVG/guide/units.html
1802		svg_unit --> "%".
1803		svg_unit --> "ch".
1804		svg_unit --> "cm".
1805		svg_unit --> "em".
1806		svg_unit --> "ex".
1807		svg_unit --> "in".
1808		svg_unit --> "mm".
1809		svg_unit --> "pc".
1810		svg_unit --> "pt".
1811		svg_unit --> "px".
1812		svg_unit --> "deg". % angle units
1813		svg_unit --> "grad".
1814		svg_unit --> "rad".
1815		svg_unit --> "turn".
1816		svg_unit --> "rem". % root em
1817		svg_unit --> "vh". % viewport height unit (1%)
1818		svg_unit --> "vw". % viewport width unit (1%)
1819		svg_unit --> "vmin". % min ov vh, vw
1820		svg_unit --> "vmax". % max ov vh, vw
1821
1822
1823		optws --> " ",!,optws.
1824		optws --> [].
1825
1826		digit(X) :- X >= 48, X =< 57.
1827
1828		is_svg_number_attribute(Attr) :- is_svg_number_attribute(Attr,_).
1829
1830
1831		% some checks to see whether the attribute is supported by the given SVG class
1832
1833		check_attribute_is_supported(SVG_Class,DefPos,svg_attribute(Name,_V)) :- !,
1834		(nonvar(SVG_Class), check_is_number_attribute(Name,SVG_Class,DefPos) -> true
1835		% TODO: check color and other attributes, see also check_attribute_type
1836		; check_attribute_name_is_supported(SVG_Class,Name,DefPos)).
1837		check_attribute_is_supported(S,DefPos,F) :-
1838		add_internal_error('Illegal call:',check_attribute_is_supported(S,DefPos,F)).
1839
1840		% if these special attributes occur here, something went wrong, e.g.,
1841		% when separating static/dynamic parts
1842		check_unsupported_special_visb_attribute(visb_objects,_,_) :- !,fail. % here we can process everything
1843		check_unsupported_special_visb_attribute(SpecialClass,DefPos,svg_attribute(Name,_)) :-
1844		special_visb_attribute_not_allowed_in_dynamic_objects(Name,SpecialClass,Kind),
1845		ajoin(['The VisB special attribute ',Name,' cannot be used here (',SpecialClass,' use separate ',Kind,' definition): '],Msg),
1846		add_warning(visb_visualiser,Msg,Name,DefPos).
1847
1848		special_visb_attribute_not_allowed_in_dynamic_objects(hover,SC,'VISB_SVG_HOVERS') :- SC \= visb_hovers.
1849		special_visb_attribute_not_allowed_in_dynamic_objects(hovers,SC,'VISB_SVG_HOVERS') :- SC \= visb_hovers.
1850		special_visb_attribute_not_allowed_in_dynamic_objects(event,SC,'VISB_SVG_EVENTS') :- SC \= visb_events.
1851		special_visb_attribute_not_allowed_in_dynamic_objects(events,SC,'VISB_SVG_EVENTS') :- SC \= visb_events.
1852		special_visb_attribute_not_allowed_in_dynamic_objects(predicate,SC,'VISB_SVG_EVENTS') :- SC \= visb_events.
1853		special_visb_attribute_not_allowed_in_dynamic_objects(predicates,SC,'VISB_SVG_EVENTS') :- SC \= visb_events.
1854		special_visb_attribute_not_allowed_in_dynamic_objects(preds,SC,'VISB_SVG_EVENTS') :- SC \= visb_events.
1855
1856
1857		check_attribute_name_is_supported(SVG_Class,Name,DefPos) :-
1858		nonvar(SVG_Class),
1859		is_html_tag(SVG_Class),
1860		\+ is_svg_shape_class(SVG_Class), % script and title can be both SVG and HTML
1861		!,
1862		(is_html_attribute(Name)
1863		-> true % TODO: we could check whether attribute appropriate for Tag
1864		; is_virtual_svg_attribute(Name) -> true % Virtual VisB attribute like children, text, ...
1865		; ajoin(['Unknown HTML attribute used inside HTML tag ',SVG_Class],Msg),
1866		add_visb_lint_message(Msg,Name,DefPos)
1867		).
1868		check_attribute_name_is_supported(_SVG_Class,Name,DefPos) :-
1869	?	\+ is_svg_attribute(Name),
1870		!,
1871		(fix_svg_attribute(Name,GraphVizTranslName)
1872		-> ajoin(['Unknown SVG attribute (maybe you want to use ',GraphVizTranslName,' ?): '],Msg),
1873		add_warning(visb_visualiser,Msg,Name,DefPos)
1874		; get_all_svg_attributes(Attrs),
1875		(get_possible_fuzzy_matches_and_completions_msg(Name,Attrs,FMsg)
1876		-> ajoin(['Unknown SVG attribute (did you mean ',FMsg,' ?): '],Msg),
1877		add_warning(visb_visualiser,Msg,Name,DefPos) % create warning, as it is likely we have made an error
1878		; is_dot_attribute(Name)
1879		-> add_warning(visb_visualiser,'This Dot/Graphviz attribute is not a valid SVG attribute: ',Name,DefPos)
1880		; get_preference(visb_strict_checking,false)
1881		-> add_visb_lint_message('Unknown SVG attribute',Name,DefPos)
1882		; add_warning(visb_visualiser,'Unknown SVG attribute (set VISB_LINT to FALSE to avoid warning): ',Name,DefPos)
1883		)
1884		).
1885		check_attribute_name_is_supported(_,_,_).
1886
1887		% add message or warning, depending on VISB_LINT setting
1888		add_visb_lint_message(Msg,Obj,Pos) :- get_preference(visb_strict_checking,false), !,
1889		ajoin([Msg,': '],Msg2),
1890		add_message(visb_visualiser,Msg2,Obj,Pos).
1891		add_visb_lint_message(Msg,Obj,Pos) :-
1892		ajoin([Msg,' (set VISB_LINT to FALSE to avoid warning): '],Msg2),
1893		add_warning(visb_visualiser,Msg2,Obj,Pos).
1894
1895
1896		% succeed if attribute is a number attribute and perform a check the attribute is supported by the class
1897		check_is_number_attribute(Attr,Class,Pos) :-
1898		is_svg_number_attribute(Attr,ClassList),
1899		(nonvar(Class), nonmember(Class,ClassList)
1900		-> (equivalent_attribute(Attr,List2,NewAttr), member(Class,List2)
1901		-> ajoin(['The number attribute ',Attr,' is not supported for SVG class ',Class,', use: '],Msg),
1902		add_warning(visb_visualiser,Msg,NewAttr,Pos)
1903		; ajoin(['The number attribute ',Attr,' is not supported for this SVG class: '],Msg),
1904		add_warning(visb_visualiser,Msg,Class,Pos)
1905		)
1906		; true
1907		).
1908
1909		% optionally rewrite record field to alternative spelling
1910		opt_rewrite_field_name(Name,Res) :-
1911		(alternative_spelling(Name,Alt) -> Res=Alt ; Res=Name).
1912
1913		% these alternatives are useful e.g. in TLA+ without backquote:
1914		alternative_spelling(colour,'color').
1915		alternative_spelling(fill_opacity,'fill-opacity').
1916		alternative_spelling(fill_rule,'fill-rule').
1917		alternative_spelling(font_family,'font-family').
1918		alternative_spelling(font_size,'font-size').
1919		alternative_spelling(font_style,'font-style').
1920		alternative_spelling(font_variant,'font-variant').
1921		alternative_spelling(font_weight,'font-weight').
1922		alternative_spelling(marker_end,'marker-end').
1923		alternative_spelling(marker_start,'marker-start').
1924		alternative_spelling(stroke_opacity,'stroke-opacity').
1925		alternative_spelling(stroke_dasharray,'stroke-dasharray').
1926		alternative_spelling(stroke_linecap,'stroke-linecap').
1927		alternative_spelling(stroke_linejoin,'stroke-linejoin').
1928		alternative_spelling(stroke_width,'stroke-width').
1929
1930
1931		% used to suggest fixing unsupported attributes in SVG objects:
1932		equivalent_attribute(cx,[rect],x).
1933		equivalent_attribute(cy,[rect],y).
1934		equivalent_attribute(x,[circle,ellipse],cx).
1935		equivalent_attribute(x,[line],x1).
1936		equivalent_attribute(y,[circle,ellipse],cy).
1937		equivalent_attribute(y,[line],y1).
1938		equivalent_attribute(r,[rect],rx). % ry also exists
1939		equivalent_attribute(rx,[circle],r).
1940		equivalent_attribute(width,[circle],r).
1941		equivalent_attribute(width,[ellipse],rx).
1942		equivalent_attribute(height,[ellipse],ry).
1943
1944
1945		% ----------------
1946
1947		% parse and load an individual JSON VisB item, e.g, :
1948		% {
1949		% "id":"train_info_text",
1950		% "attr":"x",
1951		% "value":"real(train_rear_end)*100.0/real(TrackElementNumber+1)",
1952		% "comment":"move info field above train"
1953		% },
1954		process_visb_json_item(File,Json) :-
1955		process_repeat(0,Json,File,add_visb_json_item).
1956
1957		add_visb_json_item(File,json(List)) :-
1958		get_attr_true(ignore,List,File), % ignore this item
1959		!.
1960		add_visb_json_item(File,json(List)) :-
1961		del_attr_with_pos(id,List,string(ID),L1,File,PosStartOfItem),
1962		!,
1963		process_visb_json_item_id(File,L1,ID,PosStartOfItem).
1964		add_visb_json_item(File,Json) :-
1965		!,
1966		get_pos_from_list(Json,File,Pos),
1967		add_error(visb_visualiser,'VisB Item has no id attribute:',Json,Pos).
1968
1969		process_visb_json_item_id(File,L1,ID,PosStartOfItem) :-
1970	?	del_attr(attr,L1,string(Attr),L2), % VisB has attr and value infos
1971		force_del_attr_with_pos(value,L2,string(Formula),L3,File,PosFormula),
1972		!,
1973	?	(del_attr(comment,L3,string(Desc),L4) -> true ; Desc = '',L4=L3),
1974		debug_format(19,' Processing id:~w attr:~w : value:~w desc:~w~n',[ID,Attr,Formula,Desc]),
1975		actually_add_visb_json_item(ID,Attr,Formula,Desc,L4,PosStartOfItem,PosFormula,File).
1976		process_visb_json_item_id(File,L1,ID,PosStartOfItem) :-
1977		get_attr(SomeSVGAttr,L1,_V),
1978	?	is_svg_attribute(SomeSVGAttr),
1979		debug_format(19,'Detected new style VisB JSON declaration with id:~w and SVG attr:~w~n',[ID,SomeSVGAttr]),
1980		!,
1981		% object is in new format with multiple attributes "x":"0" rather than "attr":"x", "value":"0"
1982		(del_attr(comment,L1,string(Desc),L2) -> true ; Desc = '',L2=L1),
1983	?	(non_det_del_attr_with_pos(SVGATTR,L2,string(Formula),L3,File,PosFormula),
1984		is_visb_item_svg_attribute(PosFormula,SVGATTR,Formula),
1985		debug_format(19,' -> Processing new style id:~w attr:~w : value:~w desc:~n',[ID,SVGATTR,Formula,Desc]),
1986		actually_add_visb_json_item(ID,SVGATTR,Formula,Desc,L3,PosStartOfItem,PosFormula,File),
1987		fail
1988		;
1989		true).
1990		process_visb_json_item_id(_File,_JsonList,ID,PosStartOfItem) :-
1991		!,
1992		add_error(visb_visualiser,'Illegal VisB Item without attr and value fields:',ID,PosStartOfItem).
1993
1994		is_visb_item_svg_attribute(Pos,Attr,Val) :-
1995		Attr \= override, % so we ignore a possible override attribute
1996	?	(is_svg_attribute(Attr) -> true
1997		; add_warning(visb_visualiser,'Ignoring unknown attribute: ',Attr=Val,Pos),
1998		fail
1999		).
2000
2001
2002		actually_add_visb_json_item(ID,Attr,Formula,Desc,JsonList,PosStartOfItem,PosFormula,File) :-
2003		set_error_context(visb_error_context(item,ID,Attr,PosFormula)),
2004		atom_codes(Formula,FormulaC),
2005		(parse_expr_for_visb(FormulaC,JsonList,PosFormula,TypedExpr)
2006		% TO DO: if optional attribute present: avoid generating errors in b_parse_machine_expression_from_codes
2007		-> assert_visb_item(ID,Attr,TypedExpr,Desc,PosStartOfItem,JsonList,File)
2008		; get_attr_with_pos(optional,JsonList,_,File,Pos)
2009		-> formatsilent('Ignoring optional VisB item for ~w (lines ~w) due to error in B formula~n',[ID,Pos])
2010		; ajoin(['Cannot parse or typecheck VisB formula for ',ID,' and attribute ',Attr,':'],Msg),
2011		add_error(visb_visualiser,Msg,Formula,PosFormula)
2012		), clear_error_context.
2013
2014
2015		% assert a VISB item (aka VISB_SVG_UPDATE)
2016		assert_visb_item(ID,Attr,_TypedExpr,_Desc,PosStartOfItem,_,_) :-
2017		visb_item(ID,Attr,_,_,_,Pos2,Meta2),
2018		!,
2019		get_file_name_msg(PosStartOfItem,From1,File1),
2020		(member(override,Meta2)
2021		-> ajoin(['Overriding VisB item',From1,File1,' for same SVG ID ',ID,' and attribute '],Msg),
2022		add_debug_message(visb_visualiser,Msg,Attr,Pos2)
2023		; ajoin(['Overriding VisB item',From1,File1,' for same SVG ID ',ID,
2024		'. Add an \"override\" attribute to remove this warning. Overriden attribute '],Msg),
2025		add_warning(visb_visualiser,Msg,Attr,Pos2),
2026		% error_context already includes attribute and ID
2027		add_message(visb_visualiser,'Overriding this stored formula for ',ID,PosStartOfItem) % provide detailed info
2028		).
2029		assert_visb_item(ID,Attr,_TypedExpr,_Desc,PosStartOfItem,_JsonList,_File) :-
2030		illegal_attribute_for_visb_item(ID,Attr),!,
2031		add_warning(visb_visualiser,'This attribute cannot be modified in a VisB item: ',Attr,PosStartOfItem).
2032		assert_visb_item(ID,Attr,TypedExpr,Desc,PosStartOfItem,JsonList,File) :-
2033		(get_attr_true(override,JsonList,File) -> Meta = [override] ; Meta=[]),
2034		% determine_type_of_visb_formula(TypedExpr,_,Class) now does take definitions into account; TODO: save info
2035		find_identifier_uses(TypedExpr,[],UsedIds),
2036		assertz(visb_item(ID,Attr,TypedExpr,UsedIds,Desc,PosStartOfItem,Meta)).
2037
2038		illegal_attribute_for_visb_item(_,children).
2039		illegal_attribute_for_visb_item(_,group_id).
2040		illegal_attribute_for_visb_item(_,id).
2041		illegal_attribute_for_visb_item(_,svg_class).
2042
2043
2044		get_file_name_msg(Pos1,' from ',File1) :- extract_tail_file_name(Pos1,File1),!.
2045		get_file_name_msg(_,'',''). % no file info
2046
2047		% ----
2048
2049		get_attr_true(Attr,JsonList,File) :-
2050		get_attr_with_pos(Attr,JsonList,TRUE,File,Pos),
2051		(json_true_value(TRUE) -> true
2052		; json_false_value(TRUE) -> fail
2053		; ajoin(['Value for attribute ',Attr,' is not true or false: '],Msg),
2054		add_warning(visb_visualiser,Msg,TRUE,Pos)
2055		).
2056
2057		json_true_value(@(true)).
2058		json_true_value(string(true)).
2059		json_true_value(number(1)).
2060
2061		json_false_value(@(false)).
2062		json_false_value(string(false)).
2063		json_false_value(number(0)).
2064
2065		% ----------------
2066		% FOR-LOOP / REPEAT processing
2067
2068		%process_repeat(RepCounter, Json, FinalCall to be executed repeatedly for each instance with File and Json, File)
2069		% RepCounter tells us which of %0, %1, ... should be replaced next
2070
2071		process_repeat(RepCount,json(JsonList),File,FinalCall) :-
2072	?	non_det_del_attr_with_pos(FOR_REP,JsonList,Value,RestJsonList,File,ForRepPos),
2073		% find first for or repeat and process it
2074		(FOR_REP=for ; FOR_REP=repeat),
2075		!,
2076		process_first_repeat(FOR_REP,Value,ForRepPos,RepCount,json(RestJsonList),File,FinalCall).
2077		process_repeat(_RepCount,Json,File,FinalCall) :-
2078		% we have processed all for/repeat loops: now perform the final call on the transformed codes
2079		call(FinalCall,File,Json).
2080
2081		process_first_repeat(for,json(ForList),ForPos,RepCount,JsonData,File,FinalCall) :-
2082		!, % we have a for loop like "for": {"from":1, "to":4}
2083		force_get_attr_nr(from,ForList,From,File),
2084		force_get_attr_nr(to,ForList,To,File),
2085		(get_attr_with_pos(step,ForList,StepAttrVal,File,StepPos),
2086		get_number_value(StepAttrVal,Step,step,StepPos)
2087		-> true % there is an explicit step attribute
2088		; Step=1),
2089		debug_format(19,' -> Iterating %~w from ~w to ~w with step ~w~n',[RepCount,From,To,Step]),
2090		R1 is RepCount+1,
2091		number_codes(RepCount,Pat),
2092		check_between(From,To,Step,ForPos), % check whether step value makes sense
2093	?	( between(From,To,Step,IterElem),
2094		number_codes(IterElem,IterElemC), % we will replace the text %Pat by the text of the number IterElem
2095		replace_in_json(Pat,IterElemC,JsonData,ReplacedJsonData), % replace within other for/repeat loops, but also other attributes
2096		process_repeat(R1,ReplacedJsonData,File,FinalCall), % now process next loop or finish
2097		fail
2098		; true).
2099		process_first_repeat(repeat,array(RepList),RepPos,RepCount,JsonData,File,FinalCall) :-
2100		!, % we have a repetition like "repeat": ["tr1","tr2"] or "repeat": [ ["1","2"] , ...]
2101		(RepList=[array(L1)|_], length(L1,Len)
2102		-> NewRepCount is RepCount+Len, % we have a multi-repeat with list of values to be replaced
2103		LastRepCount is NewRepCount-1,
2104		debug_format(19,' -> Iterating repeat (%~w,...,%~w) over ~w~n',[RepCount,LastRepCount,RepList]),
2105		check_all_same_length_json(RepList,Len,RepPos)
2106		; NewRepCount is RepCount+1, % next replacement starts at $(RepCount+1)
2107		debug_format(19,' -> Iterating repeat (%~w) over ~w~n',[RepCount,RepList])
2108		),
2109	?	( member(IterElem,RepList),
2110		multi_replace_in_json(IterElem,RepCount,JsonData,ReplacedJsonData), % replace within other for/repeat loops, but also other attributes
2111		process_repeat(NewRepCount,ReplacedJsonData,File,FinalCall), % now process next loop or finish
2112		fail
2113		; true).
2114
2115		check_all_same_length_json(List,ExpectedLen,Pos) :-
2116		nth1(Nr,List,Json),
2117		(Json=array(SubList),length(SubList,Len) -> Len \= ExpectedLen ; Len='not a list'),
2118		!,
2119		ajoin(['The element number ',Nr,' of the repeat list has not the expected length of ',ExpectedLen,', length is: '],Msg),
2120		add_warning(visb_visualiser,Msg,Len,Pos).
2121		check_all_same_length_json(_,_,_).
2122
2123		json_value_to_codes(@(Literal), C) :- atom(Literal), !, atom_codes(Literal, C).
2124		json_value_to_codes(number(Number), C) :- number(Number), !, number_codes(Number, C).
2125		json_value_to_codes(string(String), C) :- atom(String), !, atom_codes(String, C).
2126		json_value_to_codes(Json, _) :- !, add_error(json_value_to_codes,'Cannot convert json term to codes:', Json), fail.
2127
2128		% replace (possibly) multiple patterns at once
2129		multi_replace_in_json(array([]),_RepCount,JsonIn,JsonOut) :- !, JsonOut=JsonIn.
2130		multi_replace_in_json(array([IterElem|TIT]),RepCount,JsonIn,JsonOut) :-
2131		!,
2132		number_codes(RepCount,Pat),
2133		json_value_to_codes(IterElem,IterElemC),
2134		%format('Replacing in JSON: ~s -> ~s~n',[Pat,IterElemC]),
2135		replace_in_json(Pat,IterElemC,JsonIn,Json),
2136		R1 is RepCount+1,
2137		multi_replace_in_json(array(TIT),R1,Json,JsonOut).
2138		multi_replace_in_json(IterElem,RepCount,JsonIn,JsonOut) :- % a value, not a list
2139		!,
2140		number_codes(RepCount,Pat),
2141		json_value_to_codes(IterElem,IterElemC),
2142		%format('Replacing in JSON: ~s -> ~s~n',[Pat,IterElemC]),
2143		replace_in_json(Pat,IterElemC,JsonIn,JsonOut).
2144
2145		check_between(_,_,Step,ForPos) :- Step =< 0, !,
2146		add_error(visb_visualiser,'The step of a for loop must be positive:',Step,ForPos),fail.
2147		check_between(From,To,Step,ForPos) :- Iters is (To-From)/Step,
2148		Iters > 100000,!,
2149		add_error(visb_visualiser,'Very large for loop:',Iters,ForPos),fail.
2150		check_between(_,_,_,_).
2151
2152
2153		% ----------------
2154
2155		% parse and load VisB events
2156		% A VisB Event looks like:
2157		% {
2158		% "id": "button",
2159		% "event": "toggle_button",
2160		% "hovers": [{ "attr":"stroke-width", "enter":"6", "leave":"1"},
2161		% { "attr":"opacity", "enter":"0.8", "leave":"1.0"}]
2162		% }
2163		process_json_event(File,Json) :-
2164		process_repeat(0,Json,File,add_visb_json_event).
2165
2166		add_visb_json_event(File,json(List)) :- get_attr_true(ignore,List,File), !. % ignore this item
2167		add_visb_json_event(File,json(List)) :-
2168		get_pos_from_list(List,File,Pos),
2169		force_del_attr(id,List,string(ID),L0,File), % for items it could make sense to not specify an id
2170	?	(del_attr(event,L0,string(Event),L1) -> true ; Event='', L1=L0),
2171		(del_attr_with_pos(predicates,L1,array(Preds),L2,File,PredPos) -> true
2172		; del_attr_with_pos(preds,L1,array(Preds),L2,File,PredPos) -> true
2173		; Preds=[], L2=L1, PredPos=unknown),
2174	?	(del_attr(hovers,L2,array(Hovers),L3) -> true ; Hovers=[],L3=L2),
2175		(del_attr(items,L3,array(EI),L4)
2176		-> (empty_b_event(Event)
2177		-> EnableItems=[],
2178		add_warning(visb_visualiser,'Ignoring enable items; you need to provide an event name:',ID,Pos)
2179		; EnableItems=EI)
2180		; EnableItems=[],L4=L3),
2181		debug_format(19,' Processing id:~w event:~w preds:~w enable:~w hovers:~w~n',[ID,Event,Preds,EnableItems,Hovers]),
2182		!,
2183		actually_add_visb_json_event(ID,Event,Preds,Hovers,EnableItems,L4,File,Pos,PredPos).
2184		add_visb_json_event(File,Json) :-
2185		!,
2186		get_pos_from_list(Json,File,Pos),
2187		add_error(visb_visualiser,'Illegal VisB Event:',Json,Pos).
2188
2189		actually_add_visb_json_event(ID,Event,JsonPreds,JsonHovers,JsonEnableItems,JsonList,File,Pos,PredPos) :-
2190		check_additional_args(JsonList,File),
2191		maplist(process_json_pred,JsonPreds,Preds),
2192		maplist(process_json_enabling_item(ID,Event,File),JsonEnableItems,EnableItems),
2193		maplist(process_json_hover(ID,File),JsonHovers,Hovers),
2194		add_visb_event(ID,Event,Preds,Hovers,EnableItems,File,Pos,PredPos,JsonList).
2195
2196
2197		add_visb_event(ID,Event,Preds,Hovers,EnableItems,File,Pos,PredPos,JsonList) :-
2198		(retract(visb_event(ID,OldEvent,OldPreds,OldTypedPred,OldFile,OldPos))
2199		-> (get_attr_true(override,JsonList,File)
2200		-> ajoin(['Overriding VisB event from file ',OldFile,' for ID: '],Msg),
2201		add_debug_message(visb_visualiser,Msg,ID,Pos),
2202		retractall(visb_hover(ID,_,_,_,_,_))
2203		; (OldFile=File
2204		-> ajoin(['No override attribute: adding VisB event ',Event,
2205		' (first event ',OldEvent,') for ID: '],Msg)
2206		; ajoin(['No override attribute: adding VisB event ',Event,
2207		' (first event ',OldEvent,' in file ',OldFile,') for ID: '],Msg)
2208		),
2209		add_debug_message(visb_visualiser,Msg,ID,Pos),
2210		assertz(auxiliary_visb_event(ID,OldEvent,OldPreds,OldTypedPred,OldPos))
2211		),
2212		assert_visb_event(ID,Event,Preds,Hovers,EnableItems,File,Pos,PredPos)
2213		% ProB2-UI cannot currently support multiple events associated with the same id
2214		% TODO: merge visb_events if we have no override attribute
2215	?	; (xtl_mode ; b_is_operation_name_or_external_subst(Event)) ->
2216		assert_visb_event(ID,Event,Preds,Hovers,EnableItems,File,Pos,PredPos)
2217		; (empty_b_event(Event) ; \+ b_or_z_mode)
2218		-> % for empty event we just want hovers
2219		(Preds = [] -> true
2220		; add_warning(visb_visualiser,'Ignoring preds for VisB event for SVG ID: ',ID,Pos)
2221		),
2222		assert_visb_event(ID,Event,[],Hovers,EnableItems,File,Pos,PredPos)
2223		; get_attr_with_pos(optional,JsonList,_,File,Pos) ->
2224		formatsilent('Ignoring optional VisB event for ~w (lines ~w) due to unknown B operation ~w~n',[ID,Pos,Event])
2225		; detect_op_call_with_paras(Event,OpName) -> % check if we have a name with parameters inside
2226		add_warning(visb_visualiser,'Ignoring parameters provided in event; use the "predicate" attribute to specify parameters: ',Event,Pos),
2227		assert_visb_event(ID,OpName,Preds,Hovers,EnableItems,File,Pos,PredPos)
2228		; atom(Event), atom_prefix('{',Event) ->
2229		ajoin(['Unknown B operation ', Event, ' as VisB event for SVG ID (be sure to use the "events" attribute for multiple events): '],Msg),
2230		add_warning(visb_visualiser,Msg,ID,Pos)
2231		; ajoin(['Unknown B operation ', Event, ' as VisB event for SVG ID: '],Msg),
2232		add_warning(visb_visualiser,Msg,ID,Pos)
2233		).
2234
2235		b_is_operation_name_or_external_subst(OpName) :- b_is_operation_name(OpName).
2236		b_is_operation_name_or_external_subst(Special) :- special_operation(Special).
2237
2238		% maybe we should provide those via the external substitution interface:
2239		% these are all schedulers which choose among existing enabled operations in some manner
2240		special_operation('MCTS_AUTO_PLAY').
2241		special_operation('RANDOM_ANIMATE').
2242		special_operation('RANDOM_ANIMATE_UNTIL_LTL').
2243		special_operation(F) :- external_fun_as_special_operation(F).
2244		external_fun_as_special_operation('STORE_VALUE').
2245		external_fun_as_special_operation('SET_PREF').
2246		% maybe other special names like random_animate with nr of steps, LTL until, ...
2247		special_operation_enabled('MCTS_AUTO_PLAY',_,_,_) :- mcts_auto_play_available.
2248		special_operation_enabled('RANDOM_ANIMATE',_,_,_). % TODO: check if a transition exists
2249		special_operation_enabled('RANDOM_ANIMATE_UNTIL_LTL',_,_,_).
2250		special_operation_enabled(F,_,_,_) :- external_fun_as_special_operation(F).
2251
2252		% detect simple operation call with parameters
2253		detect_op_call_with_paras(Event,OpName) :- atom(Event),
2254		atom_codes(Event,Codes), parse_op_call_name(OpC,Codes,_),!,
2255		atom_codes(OpName,OpC),
2256		b_is_operation_name_or_external_subst(OpName).
2257
2258		parse_op_call_name([X|T]) --> alpha(X), parse_op_call_name2(T).
2259		parse_op_call_name2([]) --> "(".
2260		parse_op_call_name2([H|T]) --> alphadigit(H), parse_op_call_name2(T).
2261
2262		alpha(X) --> [X],({X>=97, X=<122} ; {X>=65, X=<90}).
2263		alphadigit(X) --> [X], ({X>=97,X=<122} ; {X>=65, X=<90} ; {X=95} ; {X>=48, X=<57}).
2264
2265		empty_b_event('').
2266
2267		assert_visb_event(ID,Event,Preds,Hovers,EnableItems,File,Pos,PredPos) :-
2268		construct_pre_post_predicate(ID,Event,Preds,TypedPred,PredPos),
2269		assertz(visb_event(ID,Event,Preds,TypedPred,File,Pos)),
2270		% process hovers
2271	?	(member(HoverElement,Hovers),
2272		(HoverElement=visb_hover(HoverID,Attr,EnterVal,ExitVal) -> true ; add_error(visb_visualiser,'Illegal hover term:',HoverElement),fail),
2273		assert_visb_hover(ID,HoverID,Attr,EnterVal,ExitVal,Pos),fail
2274		; true),
2275		% now process any additional items with disabled and enabled values
2276		assert_visb_enabling_item_list(Event,TypedPred,EnableItems,File,Pos).
2277
2278		process_json_pred(string(P),R) :- !, R=P.
2279		process_json_pred(Json,_) :- !, add_error(visb_visualiser,'Illegal json term for predicate:',Json), fail.
2280
2281		process_json_hover(OriginID,File,json(Hover),visb_hover(ID,Attr,EnterVal,LeaveVal)) :-
2282		force_del_attr(attr,Hover,string(Attr),H2,File),
2283		force_del_attr_with_pos(enter,H2,EV,H3,File,EnterPos),
2284		force_del_attr_with_pos(leave,H3,LV,H4,File,ExitPos),
2285		(is_svg_number_attribute(Attr) % we evaluate number attributes
2286		-> get_number_value(EV,EnterVal,Attr,EnterPos),
2287		get_number_value(LV,LeaveVal,Attr,ExitPos)
2288		; string(EnterVal)=EV, string(LeaveVal)=LV % return string as is; TODO: also evaluate other attributes
2289		),
2290		(get_attr(id,H4,string(ID)) -> true ; ID=OriginID).
2291
2292
2293		assert_visb_hover(TriggerID,SVG_ID,Attr,EnterVal,ExitVal,Pos) :-
2294		assert(visb_hover(TriggerID,SVG_ID,Attr,EnterVal,ExitVal,Pos)),
2295		(visb_has_hovers(TriggerID) -> true ; assert(visb_has_hovers(TriggerID))),
2296		(visb_has_visibility_hover(SVG_ID) -> true
2297		; Attr=visibility -> assert(visb_has_visibility_hover(TriggerID)) % object can be made visible by hover
2298		; true),
2299		debug_format(19,'Adding hover for ~w : ~w.~w -> ~w <- ~w~n',[TriggerID,SVG_ID,Attr,EnterVal,ExitVal]).
2300
2301
2302		% process items in event which get translated to enabling/disabling predicates
2303		% "items":[ {"attr":"stroke-width","enabled":"10", "disabled":"1"} ]
2304		process_json_enabling_item(ID,Event,File,json(JsonList),
2305		visb_enable_item(SvgID,Attr,EnabledValExpr,DisabledValExpr,PosAttr)) :-
2306		force_del_attr_with_pos(attr,JsonList,string(Attr),L2,File,PosAttr),
2307		force_del_attr_with_pos('enabled',L2,string(EnVal),L3,File,EPos),
2308		force_del_attr_with_pos('disabled',L3,string(DisVal),L4,File,DPos),
2309		(del_attr(id,L4,string(SvgID),L5) -> true ; SvgID=ID, L4=L5),
2310		atom_codes(EnVal,EC),
2311		parse_expr_for_visb(EC,L5,EPos,EnabledValExpr),
2312		atom_codes(DisVal,DC),
2313		parse_expr_for_visb(DC,L5,DPos,DisabledValExpr),
2314		(debug_mode(off) -> true
2315		; translate_bexpression_with_limit(EnabledValExpr,30,EVS),
2316		translate_bexpression_with_limit(DisabledValExpr,30,DVS),
2317		formatsilent('Enabling item for event ~w and SVG ID ~w and attribute ~w : ~w <-> ~w~n',[Event,SvgID,Attr,EVS,DVS])
2318		).
2319
2320		assert_visb_enabling_item_list(Event,TypedPred,EnableList,File,Pos) :-
2321		maplist(check_enabling_item(Event),EnableList),
2322		(EnableList \= []
2323		-> (debug_mode(off)
2324		-> true
2325		; format('Associating enabling/disabling list with event ~w and predicate: ',[Event]), translate:print_bexpr(TypedPred),nl),
2326		assert(visb_event_enable_list(Event,TypedPred,EnableList,File,Pos))
2327		; true).
2328
2329		check_enabling_item(Event,visb_enable_item(SvgID,Attr,_,_,PosAttr)) :-
2330		(visb_item(SvgID,Attr,_,_,_Desc,DuplicatePos,_)
2331		-> (extract_span_description(DuplicatePos,DuplPos) -> true; DuplPos=DuplicatePos),
2332		ajoin(['VisB conflict for SVG ID ',SvgID,' and attribute ',Attr,
2333		'. Conflict between VisB item (',DuplPos,') and VisB enable/disable entry for event: '],Msg),
2334		add_warning(visb_visualiser,Msg,Event,PosAttr)
2335		; true).
2336
2337		valid_additional_attributes(comment).
2338		valid_additional_attributes(description).
2339		valid_additional_attributes(optional).
2340		valid_additional_attributes(override).
2341
2342		% check if there are additional unprocessed args and generate a warning
2343		check_additional_args(JsonList,File) :-
2344		get_attr_with_pos(Attr,JsonList,_,File,Pos),
2345		\+ valid_additional_attributes(Attr),
2346		add_warning(visb_visualiser,'Ignoring unknown JSON field: ',Attr,Pos),
2347		fail.
2348		check_additional_args(_,_).
2349
2350
2351		% construct a pre-post typed predicate for a VisB Event
2352		construct_pre_post_predicate(SvgID,OpName,Preds,TypedPred,Pos) :-
2353		set_error_context(visb_error_context(event,SvgID,OpName,Pos)),
2354		maplist(construct_pre_post_pred(OpName,Pos),Preds,TL),
2355		clear_error_context,
2356		conjunct_predicates(TL,TypedPred).
2357
2358
2359		construct_pre_post_pred(OpName,Pos,PredStr,TypedPred) :- empty_b_event(OpName),!,
2360		add_error(visb_visualiser,'Cannot parse VisB event predicate without event name:',PredStr,Pos),
2361		TypedPred = b(truth,pred,[]).
2362		construct_pre_post_pred(OpName,Pos,String,TypedExpr) :- special_operation(OpName),!,
2363		% we have a special operation; allow to provide an expression with options/parameters
2364		construct_pre_post_for_special(Pos,String,TypedExpr).
2365		construct_pre_post_pred(OpName,Pos,String,TypedPred) :-
2366		atom_codes(String,Codes), replace_special_patterns(Codes,RCodes,Pos), %format("Replaced : ~S~n",[RCodes]),
2367		get_visb_extra_scope([identifier(VisBExtraScope)]),
2368		visb_click_meta_b_type(MetaRecType),
2369		ExtraScope = [identifier([b(identifier('VISB_CLICK_META_INFOS'),MetaRecType,[visb_generated])|VisBExtraScope])],
2370		(b_parse_machine_operation_pre_post_predicate(RCodes,ExtraScope,TypedPred,OpName,gen_parse_errors_for(Pos))
2371		-> true
2372		; add_error(visb_visualiser,'Error for VisB event predicate:',String,Pos),
2373		TypedPred = b(truth,pred,[])
2374		).
2375
2376		construct_pre_post_for_special(Pos,Pred,TypedExpr) :- member(Pred,[btrue,bfalse]), !,
2377		add_warning(visb_visualiser,'Special operations require an expression specifying the parameter values, not a predicate: ',Pred,Pos),
2378		TypedExpr = b(integer(0),integer,[]).
2379		construct_pre_post_for_special(Pos,String,TypedExpr) :-
2380		atom_codes(String,Codes),
2381		GenParseErrors=gen_parse_errors_for(Pos),
2382		parse_expr(Codes,TypedExpr,GenParseErrors). % TODO: should we require a predicate instead, and provide arg names?
2383
2384		% replace special patterns by dummy values to avoid error messages in ProB2-UI
2385		replace_special_patterns([],[],_Pos) :- !.
2386		replace_special_patterns([37|T],Res,Pos) :- !, % percentage sign %
2387		replace_aux(T,Res,Pos).
2388		replace_special_patterns([H|T],[H|RT],Pos) :- !, replace_special_patterns(T,RT,Pos).
2389
2390		replace_aux(Input,Res,Pos) :-
2391		replace_pat(PAT,Replacement),
2392		append(PAT,T,Input),
2393		!,
2394		atom_codes(PatAtom,PAT),
2395		ajoin(['The %',PatAtom,' pattern is obsolete. Please use VISB_CLICK_META_INFOS\'',PatAtom,' instead.'],Msg),
2396		add_warning(visb_visualiser,Msg,'',Pos),
2397		append(Replacement,ResT,Res),
2398		replace_special_patterns(T,ResT,Pos).
2399		replace_aux(Input,[37|Res],Pos) :- !, replace_special_patterns(Input,Res,Pos).
2400
2401		replace_pat("shiftKey","VISB_CLICK_META_INFOS'shiftKey").
2402		replace_pat("metaKey","VISB_CLICK_META_INFOS'metaKey").
2403		replace_pat("pageX","VISB_CLICK_META_INFOS'pageX").
2404		replace_pat("pageY","VISB_CLICK_META_INFOS'pageY").
2405
2406
2407		% small utils:
2408		% ----------------
2409
2410		% a variation of between/3 with a step argument
2411		between(From,To,_,_) :- From > To, !,fail.
2412		between(From,_,_,From).
2413	?	between(From,To,Step,Elem) :- F1 is From+Step, between(F1,To,Step,Elem).
2414
2415
2416		parse_expr(ExprCodes,TypedExpr,_GenParseErrors) :-
2417		is_simple_classical_b_identifier_codes(ExprCodes),
2418		atom_codes(DefID,ExprCodes),
2419		visb_definition(DefID,Type,_DefFormula,Class,_VPos,_),
2420		!,
2421		TypedExpr = b(identifier(DefID),Type,[type_of_formula(Class)]).
2422		parse_expr(ExprCodes,TypedExpr,GenParseErrors) :-
2423		temporary_set_preference(allow_arith_operators_on_reals,true,CHNG),
2424		get_visb_extra_scope(ExtraScope),
2425		% formatsilent('Parsing: ~s (extra ids: ~w)~n',[ExprCodes,ExtraScope]), start_ms_timer(T1),
2426		call_cleanup(bmachine:b_parse_machine_expression_from_codes_with_prob_ids(ExprCodes,ExtraScope,TypedExpr,
2427		GenParseErrors),
2428		reset_temporary_preference(allow_arith_operators_on_reals,CHNG)).
2429		%stop_ms_walltimer_with_msg(T1,'parsing: ').
2430		% TODO: we could share a machine parameter M like in prob2_interface
2431		% so that b_type_expression_for_full_b_machine will load machine only once
2432		% cf b_type_open_predicate_for_full_b_machine
2433
2434		determine_type_of_visb_formula(b(_,_,[type_of_formula(Class)]),all,Res) :- !,
2435		Res = Class. % generated by VisB, TODO: store UsedTIds in type_of_formula(.)
2436		determine_type_of_visb_formula(TypedExpr,TIds,Class) :-
2437		determine_type_of_formula_with_visb_defs(TypedExpr,TIds,Class).
2438
2439		%check for used_ids inside TypedExpr an see what type of visb_definition are used
2440		determine_type_of_formula_with_visb_defs(TypedExpr,TIds,ResClass) :-
2441		determine_type_of_formula(TypedExpr,TIds,Class1), % compute class w/o knowledge of VisB definitions
2442	?	(class_more_general_than(Class2,Class1),
2443	?	required_by_visb_def(TIds,Class2) -> Class=Class2
2444		; Class=Class1),
2445		(Class=requires_variables -> ResClass=Class
2446		; expression_requires_state(TypedExpr) -> ResClass = requires_variables
2447		; ResClass=Class).
2448
2449
2450		expression_requires_state(TypedExpr) :-
2451		(map_over_bexpr(sub_expression_requires_state,TypedExpr) -> true ; fail).
2452		% TODO: should we also check is_not_declarative/1 ? e.g., for RANDOM or CHANGED
2453		sub_expression_requires_state(external_pred_call(P,_)) :- external_function_requires_state(P).
2454		sub_expression_requires_state(external_function_call(P,_)) :- external_function_requires_state(P).
2455
2456
2457		class_more_general_than(requires_variables,requires_nothing).
2458		class_more_general_than(requires_variables,requires_constants).
2459		class_more_general_than(requires_constants,requires_nothing).
2460
2461		required_by_visb_def(TIds,Class) :-
2462	?	member(TID,TIds), get_texpr_id(TID,ID),visb_definition(ID,_,_,Class,_,_).
2463
2464
2465		get_visb_extra_scope([identifier(ExtraIDs)]) :-
2466		get_visb_extra_identifiers(ExtraIDs).
2467		get_visb_extra_identifiers(ExtraIDs) :-
2468		findall(b(identifier(ID),Type,[visb_generated]),visb_definition(ID,Type,_,_,_,_),ExtraIDs).
2469
2470		% replace a pattern code prefixed by % by another code list
2471		replace_in_json(Pattern,RepStr,string(Val),string(NewVal)) :- !, replace_atom(Pattern,RepStr,Val,NewVal).
2472		replace_in_json(Pattern,RepStr,array(Vals),array(NewVals)) :- !, maplist(replace_in_json(Pattern,RepStr),Vals,NewVals).
2473		replace_in_json(Pattern,RepStr,json(Vals),json(NewVals)) :- !, maplist(replace_in_json_pair(Pattern,RepStr),Vals,NewVals).
2474		replace_in_json(_,_,Val,Val). % number/literal (no replacement necessary)
2475
2476		replace_in_json_pair(Pattern,RepStr,'='(KIn,VIn,Pos),'='(KOut,VOut,Pos)) :-
2477		replace_atom(Pattern,RepStr,KIn,KOut),
2478		replace_in_json(Pattern,RepStr,VIn,VOut).
2479
2480		replace_atom(Pattern,RepStr,Val,NewVal) :-
2481		atom_codes(Val,Codes),
2482		replace_pat(Pattern,RepStr,NewCodes,Codes,[]),
2483		atom_codes(NewVal,NewCodes). % TO DO: keep as codes for efficiency
2484
2485		:- assert_must_succeed((visb_visualiser: replace_pat("0","_1_",Res,"ab%0cd",[]), Res == "ab_1_cd")).
2486		:- assert_must_succeed((visb_visualiser: replace_pat("0","",Res,"ab%0%0cd%0",[]), Res == "abcd")).
2487		% dcg utility to replace %Pat by NewStr constructing Res
2488		replace_pat(Pat,NewStr,Res) --> "%", Pat, !, {append(NewStr,TR,Res)}, replace_pat(Pat,NewStr,TR).
2489		replace_pat(Pat,RepStr,[H|T]) --> [H],!, replace_pat(Pat,RepStr,T).
2490		replace_pat(_,_,[]) --> [].
2491
2492
2493		% small JSON utils:
2494		% ----------------
2495
2496	?	get_attr(Attr,List,Val) :- member('='(Attr,Val,_),List).
2497		get_attr_with_pos(Attr,List,Val,File,Pos) :-
2498		El = '='(Attr,Val,_),
2499	?	member(El,List),
2500		get_pos_from_list([El],File,Pos).
2501
2502	?	del_attr(Attr,List,Val,Rest) :- select('='(Attr,Val,_Pos),List,Rest).
2503		%del_attr_with_pos(Attr,List,Val,Rest,Pos) :- select('='(Attr,Val,Pos),List,Rest).
2504	?	del_attr_with_pos(Attr,List,Val,Rest,File,PosTerm) :- select('='(Attr,Val,From-To),List,Rest),!,
2505		PosTerm = src_position_with_filename_and_ec(From,1,To,1,File).
2506	?	non_det_del_attr_with_pos(Attr,List,Val,Rest,File,PosTerm) :- select('='(Attr,Val,From-To),List,Rest),
2507		PosTerm = src_position_with_filename_and_ec(From,1,To,1,File).
2508
2509		force_del_attr(Attr,List,Val,Rest,File) :- force_del_attr_with_pos(Attr,List,Val,Rest,File,_).
2510
2511	?	force_del_attr_with_pos(Attr,List,Val,Rest,File,PosTerm) :- select('='(Attr,Val,From-To),List,Rest),!,
2512		%TODO: we would ideally want to extract the exact column position of Val, for this we need to extend the JSON parser first
2513		PosTerm = src_position_with_filename_and_ec(From,1,To,1,File).
2514		force_del_attr_with_pos(Attr,List,_,_,File,_) :- get_pos_from_list(List,File,Pos),!,
2515		add_error(visb_visualiser,'The JSON object has no attribute:',Attr,Pos),fail.
2516
2517		construct_prob_pos_term(From-To,File,PosTerm) :- !,
2518		PosTerm = src_position_with_filename_and_ec(From,1,To,1,File).
2519		construct_prob_pos_term(Pos,_,Pos).
2520
2521		force_get_attr_nr(Attr,List,Nr,File) :-
2522		force_del_attr_with_pos(Attr,List,AttrVal,_,File,Pos),!,
2523		get_number_value(AttrVal,Nr,Attr,Pos).
2524
2525		get_number_value(AttrVal,Nr,Attr,Pos) :-
2526		(AttrVal = number(Nr) -> true
2527		; AttrVal = string(StrAttrVal),
2528		atom_codes(StrAttrVal,AttrValC),
2529		parse_expr(AttrValC,TypedExpr,gen_parse_errors_for(Pos)),
2530		determine_type_of_visb_formula(TypedExpr,UsedTIds,Class)
2531		% Class = requires_nothing, requires_constants, requires_variables
2532		->
2533		(Class = requires_variables
2534		-> ajoin(['The JSON formula for the attribute"',Attr,
2535		'" must not depend on variables:'],Msg),
2536		add_error(visb_visualiser,Msg,StrAttrVal,Pos),fail
2537		; Class = requires_constants,
2538		\+ is_concrete_constants_state_id(_)
2539		-> ajoin(['The JSON formula for the attribute"',Attr,
2540		'" depends on constants which have not been set up (via SETUP_CONSTANTS):'],Msg),
2541		add_error(visb_visualiser,Msg,StrAttrVal,Pos),fail
2542		; Class = requires_constants,
2543		multiple_concrete_constants_exist,
2544		ajoin(['The JSON formula for the attribute"',Attr,
2545		'" depends on constants and multiple solutions for SETUP_CONSTANTS exist:'],Msg),
2546		add_warning(visb_visualiser,Msg,StrAttrVal,Pos),fail
2547		; get_texpr_type(TypedExpr,Type),
2548		is_number_type(Type)
2549		-> eval_static_def(Class,'VisB attribute',Attr,TypedExpr,UsedTIds,ResVal,Pos),
2550		get_number_from_bvalue(ResVal,Nr)
2551		; get_texpr_type(TypedExpr,Type),
2552		% it could produce a string which is a number; we could try and convert to a number
2553		ajoin(['The type ',Type,' of the JSON value formula for the attribute "',Attr,
2554		'" is not a number:'],Msg),
2555		add_error(visb_visualiser,Msg,StrAttrVal,Pos),fail
2556		)
2557		; ajoin(['The JSON value for the attribute "',Attr,'" cannot be parsed as a number:'],Msg),
2558		add_error(visb_visualiser,Msg,AttrVal,Pos),fail).
2559
2560		is_number_type(integer).
2561		is_number_type(real).
2562
2563
2564		get_number_from_bvalue(int(Nr),Res) :- !, Res=Nr.
2565		get_number_from_bvalue(Term,Res) :- is_real(Term,Nr),!,Res=Nr.
2566
2567		get_pos_from_list(json(List),File,Pos) :- !, get_pos_from_list(List,File,Pos).
2568		get_pos_from_list([H|T],File,RPos) :-
2569		H='='(_,_,From-_),
2570		last([H|T],
2571		'='(_,_,_-To)),
2572		!,
2573		RPos=src_position_with_filename_and_ec(From,1,To,1,File).
2574		get_pos_from_list(_,File,File). % should we provide another term?
2575
2576		% ----------------------------------
2577
2578
2579		% computing updates to SVG for a given StateId:
2580		% predicate to obtain required setAttribute changes to visualise StateId
2581		% looks up visb_item facts but also evaluates VISB_SVG_UPDATE definitions
2582		get_change_attribute_for_state(StateId,SvgID,SvgAttribute,Value) :-
2583		visb_state_can_be_visualised(StateId),
2584		set_error_context(checking_context('VisB:','computing attributes for state')),
2585		get_expanded_bstate(StateId,ExpandedBState),
2586		set_context_state(StateId,get_change_attribute_for_state), % also sets it for external functions
2587		% TODO: also set history so that get_current_history in external_functions is more reliable
2588	?	call_cleanup(get_change_aux(StateId,ExpandedBState,SvgID,SvgAttribute,Value),
2589		(clear_context_state,clear_error_context)).
2590
2591		get_change_aux(StateId,ExpandedBState,SvgID,SvgAttribute,Value) :-
2592	?	get_aux2(StateId,ExpandedBState,SvgID0,SvgAttribute0,Value0,DefPos),
2593		post_process_visb_item(SvgID0,SvgAttribute0,Value0,DefPos,SvgID,SvgAttribute,Value).
2594		get_aux2(StateId,ExpandedBState,SvgID,SvgAttribute,Value,DefPos) :-
2595		% first get updates from DEFINITIONS which usually return sets of records
2596	?	get_svg_object_updates_from_definitions(ExpandedBState,SvgID,SvgAttribute,Value,DefPos),
2597		debug_format(19,' VISB_SVG_UPDATE ~w:~w = ~w (in state ~w)~n',[SvgID,SvgAttribute,Value,StateId]).
2598		get_aux2(StateId,ExpandedBState,SvgID,SvgAttribute,Value,Pos) :-
2599		% TODO: check if visibility item exists, and if value is false: do not compute the rest
2600	?	get_visb_item_formula(SvgID,SvgAttribute,Formula,Pos,ExpandedBState),
2601		% TODO: if UsedIds=[] only set attribute once, if it requires_only_constants : ditto
2602		evaluate_visb_formula(Formula,'VisB item',SvgID,ExpandedBState,FValue,Pos),
2603		%b_value_to_string(FValue,Value),
2604		extract_attr_value(SvgAttribute,FValue,Value,Pos),
2605		debug_format(19,' VisB item ~w:~w = ~w (in state ~w)~n',[SvgID,SvgAttribute,Value,StateId]).
2606
2607		% post-process certain items, like title to adapt the value and id:
2608		% SVG does not support a title attribute; we need a title child and set its text attribute
2609		post_process_visb_item(SvgID,title,Value,Pos,NewID,text,NewValue) :-
2610		(visb_svg_object_debug_info(SvgID,DebugInfo) -> ajoin([Value,'\n',DebugInfo],NewValue) ; NewValue=Value),
2611	?	(visb_svg_parent(SvgID,TitleID),
2612		visb_svg_object(TitleID,title,_,_,_)
2613		-> NewID=TitleID,
2614		debug_format(9,'Redirecting title update for ~w to child object ~w~n',[SvgID,TitleID])
2615		; visb_svg_object(SvgID,_SVG_Class,_RestAttrs,_Desc,_Pos1)
2616		-> % this is an object we created
2617		add_warning(visb_visualiser,'Could not find title child object, be sure to define a static title attribute for SVG object: ',SvgID,Pos),
2618		fail
2619		; add_warning(visb_visualiser,'SVG does not natively support title attributes: ',SvgID,Pos),
2620		fail
2621		),!.
2622		post_process_visb_item(SvgID,Attr,Value,_,SvgID,Attr,Value).
2623
2624		% ------------------
2625
2626		% convert B value to Json String
2627		b_value_to_string(string(SValue),Res) :- !, Res=SValue. % What about quoting,...?
2628		b_value_to_string(FValue,Res) :-
2629		translate_bvalue_to_codes(FValue,ValCodes),
2630		atom_codes(Res,ValCodes).
2631
2632		% attributes for which we convert pairs to the concatenation of strings
2633		is_id_or_text_attribute(id).
2634		is_id_or_text_attribute('group_id'). % works much like a parent_id; also can be used to attach animate to e.g. a rect
2635		is_id_or_text_attribute('trigger_id').
2636		is_id_or_text_attribute('trigger-id').
2637		is_id_or_text_attribute(A) :- is_text_attribute(A).
2638		% children
2639		is_text_attribute('text').
2640		is_text_attribute('transform').
2641		is_text_attribute('event'). % for VISB_SVG_EVENTS
2642		is_text_attribute('predicate'). % for VISB_SVG_EVENTS
2643		is_text_attribute('svg_class').
2644
2645
2646		b_value_to_id_string(Val,String) :- b_val_to_id_string_aux(Val,add_underscore,String).
2647		b_value_to_text_string(Val,String) :- b_val_to_id_string_aux(Val,no_underscore,String).
2648
2649		% a special string conversion which e.g., allows to use things like ("ab",2) as id which gets translated to ab2
2650		% also useful for text attributes
2651		b_val_to_id_string_aux(string(SValue),_,Res) :- !, Res=SValue.
2652		b_val_to_id_string_aux((A,B),Add,Res) :- !,
2653		b_val_to_id_string_aux(A,Add,VA), b_val_to_id_string_aux(B,Add,VB),
2654		(Add=add_underscore
2655		-> atom_concat('_',VB,VB1) % introduce separator; in case we have things like numbers so that (12,3) /= (1,23)
2656		; VB1=VB % for fields like predicate, transform, ... we do not want additional underscores
2657		),
2658		atom_concat(VA,VB1,Res).
2659		b_val_to_id_string_aux(Set,Add,Res) :- singleton_set(Set,El),!, b_val_to_id_string_aux(El,Add,Res).
2660		% TODO: maybe convert sequence of values using conc
2661		b_val_to_id_string_aux(FValue,_,Res) :-
2662		translate_bvalue_to_codes(FValue,ValCodes),
2663		atom_codes(Res,ValCodes).
2664
2665		% get either a regular VisB item or an item associated with a VisB event and its enabled status
2666		get_visb_item_formula(SvgID,SvgAttribute,Formula,Pos,_ExpandedBState) :-
2667	?	visb_item(SvgID,SvgAttribute,Formula,_UsedIds,_Desc,Pos,_). % regular VisB item
2668		get_visb_item_formula(SvgID,SvgAttribute,Formula,Pos,ExpandedBState) :- % item within VisB event
2669		visb_event_enable_list(OpName,TypedPred,EnableList,_,ItemPos),
2670		debug_format(19,'Checking enabledness of VisB event ~w~n',[OpName]),
2671		(check_enabled(OpName,TypedPred,ExpandedBState,ItemPos)
2672		-> Formula=EnabledValExpr
2673		; Formula=DisabledValExpr
2674		),
2675		member(visb_enable_item(SvgID,SvgAttribute,EnabledValExpr,DisabledValExpr,Pos), EnableList).
2676
2677		check_enabled(OpName,Pred,ExpandedBState,Pos) :-
2678		special_operation(OpName),!,
2679		special_operation_enabled(OpName,Pred,ExpandedBState,Pos).
2680		check_enabled(OpName,Pred,ExpandedBState,Pos) :-
2681		b_is_operation_name(OpName),
2682		% TODO: see if we can use GUARD without execution
2683		% TODO: not yet working for XTL mode
2684		execute_operation_by_predicate_in_state_with_pos(ExpandedBState,OpName,Pred,_OpTerm,_NewState,Pos,_).
2685
2686
2687		get_expanded_bstate(StateId,ExpandedBState) :-
2688		\+ b_or_z_mode,!,
2689		StateId \= root,
2690		% in XTL mode we need to access the state via external functions like STATE_PROPERTY
2691		get_static_visb_state([],ExpandedBState).
2692		get_expanded_bstate(StateId,ExpandedBState) :-
2693		visited_expression(StateId,State),
2694		state_corresponds_to_initialised_b_machine(State,BState),
2695		debug_format(19,'Adding VisB definitions to state: ~w~n',[StateId]),
2696		add_prob_deferred_set_elements_to_store(BState,BState2,visible), % add prob_ids
2697		findall(visb_definition(DefID,Type,DefFormula,Class,VPos,Special),
2698		visb_definition(DefID,Type,DefFormula,Class,VPos,Special),DefList),
2699		eval_defs(DefList,BState2,ExpandedBState).
2700
2701
2702		evaluate_static_visb_formula(Formula,Kind,Nr,InState,ResValue,Pos) :-
2703		get_static_visb_state(InState,StaticState),
2704		evaluate_visb_formula(Formula,Kind,Nr,StaticState,ResValue,Pos).
2705
2706		evaluate_visb_formula(Formula,Kind,Nr,BState2,ResValue,Pos) :-
2707		% add_message(visb,'Evaluating: ',Kind:Nr,Pos), debug:nl_time, %set_prolog_flag(profiling,on), print_profile,
2708	?	(b_compute_explicit_epression_no_wf(Formula,[],BState2,ResValue,Kind,Nr,Pos) -> true
2709		; add_error(visb_visualiser,'Evaluation of VisB formula failed:',Formula,Pos),
2710		fail).
2711
2712		% evaluate VisB definitions in order one by one, adding values to state
2713		eval_defs([],State,State).
2714		eval_defs([visb_definition(ID,_,TypedExpr,_Class,VPos,Special)|T],State0,State2) :-
2715		(Special \= regular_def
2716		-> State1=State0 % ignore special defs; they are processed separately
2717		; b_compute_expression_nowf(TypedExpr,[],State0,ResValue,'VisB definition',ID,VPos),
2718		State1 = [bind(ID,ResValue)|State0], % store value for later definitions and VisB items
2719		(debug_mode(off) -> true
2720		; translate_bvalue_to_codes_with_limit(ResValue,2000,RC),
2721		formatsilent(' VisB definition ~w == ~s~n',[ID,RC]))
2722		),
2723		eval_defs(T,State1,State2).
2724
2725		% check if we have a static value for a VisB definition:
2726		visb_def_static_value(DefID,Value) :-
2727	?	visb_definition(DefID,_,b(value(Value),_,_),Class,_,SpecialClass),
2728		SpecialClass = regular_def,
2729		(Class = requires_nothing ; Class = requires_constants). % probably we do not need to check this, as we have value/1
2730
2731		get_static_visb_state(InState,FullState) :-
2732		findall(bind(DefID,Value),visb_def_static_value(DefID,Value),FullState,InState).
2733		% TO DO: get state with deferred_set_elements,...
2734
2735		% ----------------------------------
2736
2737		% generate a stand-alone HTML file with a visualisation for all states in the list
2738
2739		generate_visb_html(StateIds,File,Options) :-
2740		safe_open_file(File,write,Stream,[encoding(utf8)]),
2741		generate_html_to_stream(StateIds,Stream,[html_file/File|Options]),
2742		close(Stream).
2743
2744		generate_visb_html_to_codes(StateIds,Options,Codes) :-
2745		with_open_stream_to_codes(
2746		generate_html_to_stream(StateIds,Stream,Options),
2747		Stream,Codes,[]).
2748
2749
2750		% generate an HTML file to visualise the given StateId
2751		generate_html_to_stream(StateIds,Stream,Options) :-
2752		set_id_namespace_prefix_for_states(StateIds,Options),
2753		write_visb_template('visb_template_header.html',Stream),
2754		(member(show_svg_downloads,Options) -> write_visb_template('visb_template_svg_downloads.html',Stream) ; true),
2755		format(Stream,' <script>~n',[]),
2756		retractall(js_generated_function(_)),
2757		length(StateIds,Len),
2758		format(Stream,' const differences = [~n',[]),
2759		maplist(gen_visb_visualise_function(Stream,Options,Len,StateIds),StateIds),
2760		write_visb_template('visb_template_replayTrace.html',Stream),
2761		format(Stream,' </script>~n~n',[]),
2762		gen_registerHovers_scipt(Stream,Options),
2763		write_visb_template('visb_template_middle.html',Stream),
2764		(no_svg_available
2765		-> format(Stream,' <button type="button" class="collapsible-style">No SVG Visualisation Available</button>~n',[])
2766		; % generate SVG section
2767		(member(no_header,Options) -> true
2768		; format(Stream,' <button type="button" class="collapsible collapsible-style active">SVG Visualisation</button>~n',[])
2769		),
2770		format(Stream,' <div style="position: relative;">~n',[]), % container for SVG download buttons
2771		format(Stream,' <div text-align="left" id="visb_svg_outer_container" class="svg-outer-container">~n',[]),
2772		format(Stream,' <div id="visb_svg_inner_container" class="svg-inner-container">~n',[]),
2773		%format(Stream,' <fieldset> <legend>Visualisation:</legend>~n',[]), % comment in to draw a border
2774		(StateIds = [SingleStateId] -> GenForState=SingleStateId ; GenForState=root),
2775		copy_svg_file_and_gen_objects(Stream,GenForState,_SVGinlined),
2776		% TO DO: avoid creating JS code below if _SVGinlined
2777		%format(Stream,' </fieldset>~n',[]),
2778		format(Stream,' </div>~n',[]), % inner container
2779		format(Stream,' </div>~n',[]), % outer container
2780		format(Stream,' <button id="btnResetScale" class="visualisation-button" onclick="resetScale()">Reset View</button>~n',[]),
2781		(member(show_svg_downloads,Options) ->
2782		format(Stream,' <button onclick="downloadSVG()">Save SVG (Current State)</button>~n',[]),
2783		format(Stream,' <button onclick="downloadAllSVGs()">Save all SVGs</button>~n',[])
2784		; true),
2785		format(Stream,' </div>~n',[]) % container for SVG download buttons
2786		),
2787		(Len>1, memberchk(show_sequence_chart,Options) % don't export PlantUML for list of state IDs (sequence chart depends on trace)
2788		-> (create_temp_puml_files(Len,Files),
2789		uml_generator:write_uml_sequence_chart_all_states(Files), % generate .puml files
2790		tools_commands:gen_plantuml_output(Files,svg,[]) % generate .svg files
2791		-> format(Stream,' <button type="button" class="collapsible collapsible-style active">Sequence Chart Visualisation</button>~n',[]),
2792		format(Stream,' <div class="seq-chart-container">~n',[]),
2793		reverse(Files,RFiles),
2794		write_temp_puml_outputs(1,RFiles,Stream), % write SVG contents to HTML
2795		format(Stream,' </div>~n',[])
2796		; add_warning(visb_visualiser,'HTML export: did not write the Sequence Diagram Visualisation due to an error in the PlantUML call.'),
2797		format(Stream,' <button type="button" class="collapsible-style">No Sequence Chart Visualisation Available</button>~n',[])
2798		)
2799		; true),
2800		(Len>1
2801		-> %format(Stream,'~n<h3>Run Trace</h3>~n',[]),
2802		format(Stream,' <button type="button" class="collapsible-style">Replay Trace</button>~n',[]),
2803		format(Stream,' <div class="coll-content-vis">~n',[]),
2804		format(Stream,' <button id="btnPrev" onclick="backStep()" title="Go back one step">« Back</button>~n',[]),
2805		format(Stream,' <button id="btnNext" onclick="forwardStep()" title="Go forward one step">Forward »</button>~n',[]),
2806		format(Stream,' <button onclick="runAll(10)" title="Fast replay of entire trace">Run Trace (10 ms delay)</button>~n',[]),
2807		format(Stream,' <button onclick="runAll(500)" title="Slow replay of entire trace">Run Trace (500 ms delay)</button>~n',[]),
2808		format(Stream,' <button onclick="runAll(parseInt(delayInput.value))" title="Custom replay of entire trace">Run Trace with Delay (ms):</button>~n',[]),
2809		format(Stream,' <input id="delayInput" type="number" value="1000" min="0" step="100" onkeydown="if(event.key===\'Enter\') runAll(parseInt(this.value))">~n',[]),
2810		format(Stream,' <label class="visb-messages" style="float:right">~n',[]),
2811		format(Stream,' <input type="checkbox" id="checkbox_focus_svg"> Focus changes in SVG~n',[]),
2812		format(Stream,' </label>~n',[]),
2813		% We could decide to provide an option/preference for generating the visb_debug_messages field:
2814		% (check that ProB2-UI also generates this text field)
2815		format(Stream,' <br><label id="visb_debug_messages" class="visb-messages"> </label>~n',[]),
2816		format(Stream,' </div>~n',[]),
2817		format(Stream,' <progress id="trace_meter" min="0" max="~w" value="0"></progress>~n',[Len]) % progress of trace replay; note <meter> element also works
2818		; true
2819		),
2820		% generate a table with variables, constants, ...
2821		gen_state_table(Stream,Options,StateIds),
2822		gen_source_code_section(Stream,Options),
2823		% generate a table with the saved trace steps:
2824		(Len>1 -> gen_trace_table(Stream,StateIds) ; true),
2825		write_version_info(Stream,Options),
2826		(last(StateIds,_)
2827		-> format(Stream,' <script> replayStep(~w,false); </script>~n',[Len])
2828		% show the visualisation of the last state by default (without focussing affected elements)
2829		; true % trace is empty, there is no last item
2830		),
2831		write_visb_template('visb_template_footer.html',Stream),
2832		clear_id_namespace_prefix.
2833
2834		create_temp_puml_files(Len,[]) :- Len<1, !.
2835		create_temp_puml_files(Len,[Path|T]) :-
2836		system_call:get_temporary_filename('for_html.puml',Path),
2837		NewLen is Len-1,
2838		create_temp_puml_files(NewLen,T).
2839
2840
2841		write_temp_puml_outputs(_,[],_).
2842		write_temp_puml_outputs(Nr,[File|T],Stream) :-
2843		tools:split_filename(File,FileRoot,_Ext),
2844		ajoin([FileRoot,'.svg'],SvgFile),
2845		format(Stream,' <div id="seq_chart_~w" style="display:none">~n',[Nr]), % container for seq. charts
2846		write_file_to_stream(SvgFile,Stream),
2847		format(Stream,' </div>~n',[]), % container for seq. charts
2848		NNr is Nr+1,
2849		write_temp_puml_outputs(NNr,T,Stream).
2850
2851		% -----------------
2852
2853
2854		write_version_info(_,Options) :-
2855		member(no_version_info,Options),!.
2856		write_version_info(Stream,Options) :-
2857		version_str(Str),datime(datime(Yr,Mon,Day,Hr,Min,_Sec)),
2858		number_codes_min_length(Min,2,MC),
2859		format(Stream,' <button type="button" class="collapsible-style" title="Information about ProB and model">Info</button>~n',[]),
2860		format(Stream,'<div class="coll-content-vis visb-messages">~n',[]),
2861		format(Stream,'Generated on ~w/~w/~w at ~w:~s using <a href="https://prob.hhu.de/">ProB</a> version ~w~n',[Day,Mon,Yr,Hr,MC,Str]),
2862		(currently_opened_file(File)
2863		-> (File=package(Type) ->
2864		format(Stream,'<br>Main specification package: ~w~n',[Type])
2865		; atom(File), get_relative_path(File,Options,Suffix) ->
2866		format(Stream,'<br>Main specification file: ~w',[Suffix]),
2867		format_file_info(Stream,File)
2868		; format(Stream,'<br>Unknown main specification file: ~w~n',[File])
2869		)
2870		; true),
2871		(b_machine_name(MainName)
2872		-> format(Stream,'<br>Main specification name: ~w~n',[MainName]) ; true),
2873		(visb_file_loaded(JSONFile,_,ModLocTime,_),
2874		JSONFile \= ''
2875		-> get_relative_path(JSONFile,Options,JSuffix),
2876		format(Stream,'<br>Main VisB JSON file: ~w',[JSuffix]),
2877		format_modified_info(Stream,ModLocTime),
2878		(get_non_empty_svg_file(SVGFile,ModLocTime2)
2879		-> get_relative_path(SVGFile,Options,SSuffix),
2880		format(Stream,'<br>VisB SVG file: ~w',[SSuffix]),
2881		format_modified_info(Stream,ModLocTime2)
2882		; true
2883		)
2884		; true).
2885
2886		get_non_empty_svg_file(SVGFile,ModLocTime2) :-
2887		visb_svg_file(RelFile,SVGFile,_,_,ModLocTime2),
2888		RelFile \= ''.
2889
2890		format_file_info(Stream,File) :-
2891		catch(file_property(File, modify_localtime, ModLocTime),
2892		E,
2893		(add_visb_lint_message('Could not obtain modification time for file',E,unknown), fail)),
2894		!,
2895		format_modified_info(Stream,ModLocTime).
2896		format_file_info(Stream,_) :- nl(Stream).
2897
2898
2899		get_relative_path(File,Options,RelPath) :-
2900	?	member(html_file/HF,Options),
2901		absolute_file_name(File,AF,[]),
2902		absolute_file_name(HF,AHF,[]),
2903		!,
2904		gen_relative_path(AF,AHF,RelPath). % only print relative information
2905		get_relative_path(File,_,File).
2906
2907
2908		% -----------------
2909
2910		% gen a table with all the individual steps of the trace
2911		gen_trace_table(Stream,StateIds) :-
2912		length(StateIds,Len),
2913		%format(Stream,'~n<h3>Trace (length=~w)</h3>~n',[Len]),
2914		format(Stream,' <button type="button" class="collapsible collapsible-style active">Trace (length=~w)</button>~n',[Len]),
2915		format(Stream,'<div class="coll-content-vis">~n',[]),
2916	?	(member(Obj,StateIds), get_state_and_action(Obj,_,_,DescStr), DescStr \= ''
2917		-> Opt=with_description ; Opt=no_description),
2918		gen_trace_table2(Stream,StateIds,Opt).
2919
2920		gen_trace_table2(Stream,StateIds,no_description) :-
2921		format(Stream,' <table> <tr> <th>Nr</th> <th>Event</th> <th>Target State ID</th> </tr>~n',[]),
2922	?	nth1(Nr,StateIds,Obj),
2923		get_state_and_action(Obj,StateId,ActionStr,_),
2924		((visited_state_corresponds_to_initialised_b_machine(StateId) ; xtl_mode) % allow onclick to all rows in xtl_mode
2925		-> (invariant_violated(StateId) -> BtnStyle='style="background-color:rgb(255,179,179);border-radius:6px" ' ; BtnStyle=''),
2926		format(Stream,'~n <tr id="row~w" onclick="replayStep(~w)"><td>~w</td><td style="cursor:pointer">~w</td><td><button ~wonclick="replayStep(~w);">State ~w</button></td></tr>~n',
2927		[Nr,Nr,Nr,ActionStr,BtnStyle,Nr,StateId])
2928		; format(Stream,'~n <tr id="row~w"><td>~w</td><td style="cursor:not-allowed">~w</td><td>State ~w</td></tr>~n',
2929		[Nr,Nr,ActionStr,StateId])
2930		),
2931		fail.
2932		gen_trace_table2(Stream,StateIds,with_description) :-
2933		format(Stream,' <table> <tr> <th>Nr</th> <th>Event</th> <th>Description</th> <th>Target State ID</th> </tr>~n',[]),
2934	?	nth1(Nr,StateIds,Obj),
2935		get_state_and_action(Obj,StateId,ActionStr,DescStr),
2936		atom_codes(ActionStr,ActionCodes),html_escape_codes(ActionCodes,EAS),
2937		atom_codes(DescStr,DescCodes),html_escape_codes(DescCodes,EDS),
2938		((visited_state_corresponds_to_initialised_b_machine(StateId) ; xtl_mode) % allow onclick to all rows in xtl_mode
2939		-> (invariant_violated(StateId) -> BtnStyle='style="background-color:rgb(255,179,179);border-radius:6px" ' ; BtnStyle=''),
2940		format(Stream,'~n <tr id="row~w" onclick="replayStep(~w)"><td>~w</td><td style="cursor:pointer">~s</td><td>~s</td><td><button ~wonclick="replayStep(~w);">State ~w</button></td></tr>~n',
2941		[Nr,Nr,Nr,EAS,EDS,BtnStyle, Nr,StateId])
2942		; format(Stream,'~n <tr id="row~w"><td>~w</td><td style="cursor:not-allowed">~s</td><td>~s</td><td>State ~w</td></tr>~n',
2943		[Nr,Nr,EAS,EDS,StateId])
2944		),
2945		fail.
2946		gen_trace_table2(Stream,_,_) :-
2947		format(Stream,' </table>~n </div>~n',[]).
2948
2949
2950		% utility to allow passing information about name of event/operation/action leading to state
2951		get_state_and_action(change_to_state_via_action(StateId,ActionStr,DescStr),StateId,ActionStr,DescStr) :- !.
2952		get_state_and_action(StateId,StateId,'','').
2953
2954		% -----------------
2955
2956		% inline provided svg file into html file:
2957		% second argument is either root or a particular state id for which the SVG file is to be created
2958		% the last argument is static_svg_inlined if all SVG objects were "inlined" into a single
2959		% SVG object (rather than via JavaScript functions to create the objects)
2960		copy_svg_file_and_gen_objects(Stream,_,static_svg_not_inlined) :- visb_svg_file(_,File,_,_,_), file_exists(File),
2961		!,
2962		write_file_to_stream(File,Stream),
2963		( get_visb_contents_def(Contents,DefName,DefPos,static_svg_not_inlined),
2964		ajoin(['Copying ',DefName,' *after* SVG file: '],Msg),
2965		add_message(visb_visualiser,Msg,File,DefPos),
2966		format(Stream,'~w~n',[Contents]),
2967		fail
2968		; true
2969		),
2970		gen_new_svg_objects(Stream).
2971		copy_svg_file_and_gen_objects(_,_,_) :-
2972		visb_svg_file(File,AFile,_,Pos,_),
2973		File \= '',
2974		add_error(visb_visualiser,'The specified VisB SVG file does not exist:',AFile,Pos),
2975		fail.
2976		copy_svg_file_and_gen_objects(Stream,SingleStateId,static_svg_inlined) :- % copy an empty SVG stub
2977		visb_file_loaded(_,_,_,_),!,
2978		write_default_svg_contents(Stream,inline_objects(SingleStateId)).
2979		copy_svg_file_and_gen_objects(_,_,static_svg_not_inlined). % no SVG required; we have no items or events: probably just want HTML export of variables,...
2980
2981		% TODO: precompile and always assert as visb_special_definition (we could also evaluate it; could use template strings):
2982		get_visb_contents_def(Contents,DefName,DefPos,InlineObjects) :-
2983	?	get_and_eval_special_definition('VISB_SVG_CONTENTS',DefName,visb_contents,DefPos,ResValue,InlineObjects),
2984		b_value_to_string(ResValue,Contents).
2985		get_visb_contents_def(Contents,default_svg_contents,unknown,_InlineObjects) :-
2986		% default content, for VISB_CLICK_META_INFOS'jsVars
2987		Contents = '<script>let visb_vars = {};</script>'.
2988
2989		% get a definition either from B DEFINITIONS section, or if not present from the VisB JSON special definition list
2990		get_and_eval_special_definition(Prefix,DefName,JSONBackup,DefPos,ResValue,InlineObjects) :-
2991		(b_sorted_b_definition_prefixed(expression,Prefix,DefName,DefPos),
2992	?	b_get_typed_definition(DefName,[variables_and_additional_defs],TBody)
2993		;
2994		visb_special_definition(JSONBackup,DefName,_Type,TBody,_Class,DefPos)
2995		),
2996		% TODO: warn if we use static SVG
2997	?	get_typed_static_definition_with_constants_state(DefName,TBody,
2998		Body,DefPos,ConstantsState,InlineObjects,no_separation),
2999		evaluate_visb_formula(Body,DefName,'',ConstantsState,ResValue,DefPos).
3000
3001		% check if we have a DEFINITION with the indicated prefix
3002		special_definition_exists(Prefix) :-
3003		b_sorted_b_definition_prefixed(expression,Prefix,_DefName,_DefPos).
3004
3005		write_default_svg_contents(Stream,InlineObjects) :-
3006		(visb_empty_svg_box_height_width(H,W,ViewBox) -> true ; H=400, W=400, ViewBox=''),
3007		format(Stream,'<svg xmlns=\"http://www.w3.org/2000/svg\"~n',[]),
3008		(ViewBox=''
3009		-> format(Stream,' width="~w" height="~w" viewBox="0 0 ~w ~w" >~n',[W,H,W,H])
3010		; format(Stream,' width="~w" height="~w" viewBox="~w" >~n',[W,H,ViewBox])
3011		),
3012	?	( get_visb_contents_def(Contents,_,_,InlineObjects),
3013		format(Stream,'~w~n',[Contents]),
3014		fail
3015		; true),
3016		(InlineObjects=inline_objects(StateID) -> inline_new_svg_objects(Stream,StateID) ; true),
3017		format(Stream,'</svg>~n',[]).
3018
3019		% get SVG file contents in case no SVG file is provided by user
3020		get_visb_default_svg_file_contents(Codes) :-
3021		with_open_stream_to_codes(
3022		write_default_svg_contents(Stream,inline_objects(root)),
3023		% allow inlining for groups and title children in ProB2-UI
3024		Stream,
3025		Codes, []).
3026
3027		% -----------------
3028
3029		% create a script to add all additional SVG objects
3030		gen_new_svg_objects(_) :- \+ visb_svg_object(_,_,_,_,_),!.
3031		gen_new_svg_objects(Stream) :-
3032		format(Stream, '<script>~n',[]),
3033		format(Stream, ' const svg = document.querySelector("svg");~n',[]),
3034		format(Stream, ' const svgns = "http://www.w3.org/2000/svg";~n',[]),
3035		(gen_new_svg_object(Stream,svg_root,_),fail ; true),
3036		format(Stream, '</script>~n',[]).
3037
3038		% generate JS script to create an individual new object
3039		gen_new_svg_object(Stream,ParentID,SVGID) :-
3040		visb_svg_object(SVGID,SVG_Class,AttrList,_,_Pos),
3041		(ParentID=svg_root
3042		-> (visb_svg_child(SVGID,RealParentID) % only generate root svg objects that have no parents
3043		-> visb_svg_child_of_object_from_svg_file(SVGID) % unless the parent will not be created here in this loop
3044		; RealParentID=ParentID
3045		)
3046		; RealParentID=ParentID),
3047		add_svg_id_prefix(SVGID,SVGID2),
3048		format(Stream,' if(document.getElementById("~w") == null) {~n',[SVGID2]),
3049		format(Stream,' var new___obj = document.createElementNS(svgns,"~w");~n',[SVG_Class]),
3050		format(Stream,' new___obj.setAttribute("~w","~w");~n',[id,SVGID2]),
3051		maplist(gen_new_svg_attr(Stream,SVGID2),AttrList),
3052		(RealParentID \= svg_root
3053		-> format(Stream,' document.getElementById("~w").appendChild(new___obj);~n',[RealParentID])
3054		; format(Stream,' svg.appendChild(new___obj);~n',[])
3055		),
3056		format(Stream,' }~n',[]),
3057		(visb_svg_parent(SVGID,ChildID), % we can now generate the children
3058		gen_new_svg_object(Stream,SVGID,ChildID),
3059		fail
3060		; true).
3061
3062		gen_new_svg_attr(Stream,_SVGID,svg_attribute(text,Val)) :- !,
3063		format(Stream,' new___obj.textContent = "~w";~n',[Val]).
3064		gen_new_svg_attr(Stream,_SVGID,svg_attribute(Attr,Val)) :-
3065		format(Stream,' new___obj.setAttribute("~w","~w");~n',[Attr,Val]).
3066
3067		% instead of creating a script to create new SVG objects,
3068		% create an inlined textual XML representation of the objects
3069		% this can be used to obtain a static SVG file which can be modified in an editor
3070		% and then later used instead of the VISB_SVG_OBJECTS definitions
3071		inline_new_svg_objects(Stream,StateId) :-
3072		get_dynamic_svgid_attributes_for_state(StateId,DynUpdateList), % compute updates only once
3073	?	visb_svg_object(SVGID,_,_,_,_), % lookup static SVG object
3074		\+ visb_svg_child(SVGID,_), % children will be created in the scope of their parent
3075		inline_new_svg_object(Stream,StateId,DynUpdateList,0,unknown,SVGID),
3076		fail.
3077		inline_new_svg_objects(_,_).
3078
3079		inline_new_svg_object(Stream,StateId,DynUpdateList,IndentLevel,ParentPos,SVGID) :-
3080		(visb_svg_object(SVGID,SVG_Class,StaticAttrList,_,Pos) -> true % lookup static SVG object
3081		; add_warning(visb_visualiser,'Unknown SVG child object: ',SVGID,ParentPos),fail
3082		),
3083		add_svg_id_prefix(SVGID,SVGID2), % for Jupyter
3084		indent_ws(Stream,IndentLevel),
3085		format(Stream,' <~w id="~w"',[SVG_Class,SVGID2]),
3086		(member(svgid_updates(SVGID,DynAttrList),DynUpdateList) % TODO: use avl_fetch
3087		-> override_attributes(StaticAttrList,DynAttrList,AttrList)
3088		; AttrList=StaticAttrList),
3089		maplist(format_new_svg_attr(Stream,SVGID,Pos,TextContent),AttrList),
3090		(TextContent=''
3091		-> EscapedTextContent="" % set Text variable to empty if unbound
3092		; do_not_escape_text_for_class(SVG_Class) -> atom_codes(TextContent,EscapedTextContent)
3093		; atom_codes(TextContent,TCC), html_escape_codes(TCC,EscapedTextContent)),
3094		format(Stream,'>~s',[EscapedTextContent]), % Note: this text is not inside quotes, we need HTML escape
3095		IL1 is IndentLevel+1,
3096	?	( visb_svg_parent(SVGID,Child),
3097		nl(Stream),
3098		inline_new_svg_object(Stream,StateId,DynUpdateList,IL1,Pos,Child),
3099		fail
3100		; true),
3101		format(Stream,'</~w>~n',[SVG_Class]), % end marker
3102		fail.
3103		inline_new_svg_object(_,_,_,_,_,_).
3104
3105		% for foreignObjects the text may contain HTML tags which should not be escaped:
3106		do_not_escape_text_for_class(foreignObject).
3107		do_not_escape_text_for_class(script). % otherwise " quotes will be escaped to "
3108
3109		indent_ws(_,X) :- X<1,!.
3110		indent_ws(Stream,X) :- write(Stream,' '), X1 is X-1, indent_ws(Stream,X1).
3111
3112		% combinde svg_attribute/2 terms from two sorted lists, giving precedence to second list
3113		override_attributes([],L,R) :- !, R=L.
3114		override_attributes(L,[],R) :- !, R=L.
3115		override_attributes([svg_attribute(Attr1,Val1)|T1],[svg_attribute(Attr2,Val2)|T2],[svg_attribute(Attr3,Val3)|T3]) :-
3116		(Attr1=Attr2
3117		-> Attr3=Attr1, Val3=Val2, % dynamic value Val2 takes precedence
3118		override_attributes(T1,T2,T3)
3119		; Attr1 @< Attr2 -> Attr3=Attr1, Val3=Val1, override_attributes(T1,[svg_attribute(Attr2,Val2)|T2],T3)
3120		; Attr3=Attr2, Val3=Val2, override_attributes([svg_attribute(Attr1,Val1)|T1],T2,T3)
3121		).
3122
3123		% get dynamic svg_attribute/2 list for a given state and SVG ID
3124		get_dynamic_svgid_attributes_for_state(root,List) :- !, List=[].
3125		get_dynamic_svgid_attributes_for_state(StateId,UpdateList) :-
3126		get_visb_attributes_for_state(StateId,List),
3127		sort(List,SList),
3128		group_set_attr(SList,'$$UNKNOWN$$',_,UpdateList).
3129
3130		group_set_attr([],_,[],[]).
3131		group_set_attr([set_attr(SvgID,Attr,Val)|T],SvgID,[svg_attribute(Attr,Val)|T1],T2) :- !,
3132		group_set_attr(T,SvgID,T1,T2).
3133		group_set_attr([set_attr(SvgID,Attr,Val)|T],_OldID,[],[svgid_updates(SvgID,L)|T2]) :- % a new SVGId is encountered
3134		group_set_attr([set_attr(SvgID,Attr,Val)|T],SvgID,L,T2).
3135
3136		% print svg attribute and extract text attribute
3137		format_new_svg_attr(Stream,SVGID,Pos,TextContent,svg_attribute(Attr,Val)) :- % TODO: text content
3138		(Attr=text
3139		-> (TextContent=Val -> true % TextContent is initially a variable and can be unified once
3140		; add_warning(inline_new_svg_objects,'Multiple text attributes for: ',SVGID,Pos),
3141		add_debug_message(inline_new_svg_objects,' * Using text 1: ',TextContent),
3142		add_debug_message(inline_new_svg_objects,' * Ignoring text 2: ',Val)
3143		)
3144		; number(Val) ->
3145		format(Stream,' ~w="~w"',[Attr,Val])
3146		; escape_value_to_codes_for_js(Val,ECodes) ->
3147		format(Stream,' ~w="~s"',[Attr,ECodes])
3148		; compound(Val), functor(Val,F,N) ->
3149		ajoin(['Cannot escape ',Attr,' *compound* ',F,'/',N,' value for ', SVGID,': '],Msg),
3150		add_error(visb_visualiser,Msg,Val,Pos),
3151		format(Stream,' ~w="~w"',[Attr,Val])
3152		; ajoin(['Cannot escape ',Attr,' value for ', SVGID,': '],Msg),
3153		add_error(visb_visualiser,Msg,Val,Pos),
3154		format(Stream,' ~w="~w"',[Attr,Val])
3155		).
3156
3157
3158		:- dynamic id_namespace_prefix/1.
3159		% prefix that can be useful for Jupyter notebooks so that for each state we have a different namespace
3160		% can also be useful for exporting a trace into a single HTML
3161		% TODO: does not work with JSON and SVG files
3162
3163
3164		set_id_namespace_prefix_for_states(_,Options) :-
3165		member(id_namespace_prefix(Pre),Options),!,
3166		(Pre = auto
3167		-> gensym('visb',ID), % for Jupyter this relies on the fact the gensym is *not* reset when loading another spec
3168		atom_concat(ID,'.',Prefix)
3169		; Prefix=Pre
3170		), set_id_namespace_prefix(Prefix).
3171		set_id_namespace_prefix_for_states(_,_).
3172
3173		set_id_namespace_prefix(Prefix) :- clear_id_namespace_prefix,
3174		assert(id_namespace_prefix(Prefix)).
3175		clear_id_namespace_prefix :- retractall(id_namespace_prefix(_)).
3176
3177		% add a namespace prefix to an SVG ID
3178		add_svg_id_prefix(SvgID,Res) :- id_namespace_prefix(Prefix),!,
3179		% option where we prefix all Ids with a namespace for Jupyter to combine multiple SVGs in single HTML page
3180		atom_concat(Prefix,SvgID,Res).
3181		add_svg_id_prefix(SvgID,SvgID).
3182
3183		% only add for known objects
3184		opt_add_svg_id_prefix(SvgID,Res) :- id_namespace_prefix(Prefix),
3185		visb_svg_object(SvgID,_,_,_,_),!, % only add prefix for SVG objects we know about (that were created by VisB)
3186		% option where we prefix all Ids with a namespace for Jupyter to combine multiple SVGs in single HTML page
3187		atom_concat(Prefix,SvgID,Res).
3188		opt_add_svg_id_prefix(SvgID,SvgID).
3189
3190		% -----------------
3191
3192		:- dynamic js_generated_function/1.
3193		:- dynamic last_attribute_values/3.
3194
3195		% define a visualise JS function to set the attributes for the given StateId
3196		gen_visb_visualise_function(Stream,Options,Len,StateIds,Obj) :-
3197		get_state_and_action(Obj,StateId,ActionStr,DescStr),
3198	?	nth1(Nr,StateIds,Obj),
3199		\+ js_generated_function(Nr), !,
3200		assertz(js_generated_function(Nr)),
3201		(Nr > 1 ->
3202		PrevNr is Nr-1, nth1(PrevNr,StateIds,PrevObj), get_state_and_action(PrevObj,PrevStateId,_,_)
3203		; PrevStateId = -1),
3204		visb_visualise_function_aux(Stream,Options,Len,StateId,PrevStateId,Nr,ActionStr,DescStr),
3205		(Nr == Len ->
3206		retractall(last_attribute_values(_,_,_)),
3207		format(Stream,' ]~n',[])
3208		; true).
3209		gen_visb_visualise_function(_,_,_,_,_).
3210
3211
3212		visb_visualise_function_aux(Stream,_,Len,StateId,_,Nr,ActionStr,DescStr) :-
3213		format(Stream,' [~n',[]),
3214		(Len>1 -> format(Stream,' {id: "trace_meter", attr: "value", val: "~w"},~n',[Nr]) ; true),
3215		(escape_value_to_codes_for_js(ActionStr,EAS), escape_value_to_codes_for_js(DescStr,EDS) ->
3216		% was only string_escape before; however, this turns e.g. |-> into ↦ which we don't want (we are in JS part here)
3217		format(Stream,' {id: "visb_debug_messages", attr: "text", val: "Step ~w/~w, State ID: ~w, Event: ~s ~s"},~n',[Nr,Len,StateId,EAS,EDS])
3218		; string_escape(ActionStr,SEAS), string_escape(DescStr,SEDS), % fallback
3219		format(Stream,' {id: "visb_debug_messages", attr: "text", val: "Step ~w/~w, State ID: ~w, Event: ~w ~w"},~n',[Nr,Len,StateId,SEAS,SEDS])
3220		),
3221	?	get_change_attribute_for_state(StateId,SvgID,SvgAttribute,Value),
3222		\+ last_attribute_values(SvgID,SvgAttribute,Value),
3223		retractall(last_attribute_values(SvgID,SvgAttribute,_)),
3224		assertz(last_attribute_values(SvgID,SvgAttribute,Value)),
3225		opt_add_svg_id_prefix(SvgID,SvgID2),
3226		(escape_value_to_codes_for_js(Value,ECodes)
3227		-> format(Stream,' {id: "~w", attr: "~w", val: "~s"},~n',[SvgID2,SvgAttribute,ECodes])
3228		; format(Stream,' {id: "~w", attr: "~w", val: "~w"},~n',[SvgID2,SvgAttribute,Value])
3229		),
3230		fail.
3231		visb_visualise_function_aux(Stream,Options,Len,StateId,PrevStateId,_,_,_) :-
3232		b_or_z_mode,
3233		member(show_variables(VarList),Options),
3234
3235		visited_expression(StateId,State),
3236		(visited_expression(PrevStateId,PrevState) -> true ; PrevState=root),
3237
3238		show_var_in_visb(VarList,ID),
3239	?	get_state_value_change(StateId,State,ID,Options,ResValCodes),
3240
3241		% current value:
3242		ajoin(['bVar_',ID],SvgID),
3243		change_svg_attribute_differences_aux(Stream,SvgID,'text',ResValCodes),
3244
3245		Len > 1, % don't add previous value and change markers for state-only HTML
3246		(state_corresponds_to_fully_setup_b_machine(PrevState,_), % don't show prev values before initialisation
3247	?	get_state_value_change(PrevStateId,PrevState,ID,Options,PrevResValCodes)
3248		-> true
3249		; PrevResValCodes = "?"),
3250
3251		% mark row if value has changed in the last step
3252		ajoin(['row_bVar_',ID],SvgRowID),
3253		(ResValCodes = PrevResValCodes -> RowColor = white; RowColor = '#fffacd'),
3254		change_svg_attribute_differences_aux(Stream,SvgRowID,'bgcolor',RowColor),
3255
3256		% previous value:
3257		ajoin(['bVarPrev_',ID],SvgPrevID),
3258		change_svg_attribute_differences_aux(Stream,SvgPrevID,'text',PrevResValCodes),
3259
3260		fail.
3261		visb_visualise_function_aux(Stream,_Options,Len,StateId,PrevStateId,_,_,_) :-
3262		xtl_mode,
3263
3264		bv_get_top_level(IDs),
3265		member(ID,IDs),
3266		(bv_get_value_unlimited(ID,StateId,v(Val))
3267		-> atom_codes(Val,ResValCodes)
3268		; ResValCodes = ""),
3269
3270		% current value:
3271		ajoin(['bVar_',ID],SvgID),
3272		change_svg_attribute_differences_aux(Stream,SvgID,'text',ResValCodes),
3273
3274		Len > 1, % don't add previous value and change markers for state-only HTML
3275		(PrevStateId \= root,
3276		bv_get_value_unlimited(ID,PrevStateId,v(PrevVal))
3277		-> atom_codes(PrevVal,PrevResValCodes)
3278		; PrevResValCodes = ""),
3279
3280		% mark row if value has changed in the last step
3281		ajoin(['row_bVar_',ID],SvgRowID),
3282		(ResValCodes = PrevResValCodes -> RowColor = white; RowColor = '#fffacd'),
3283		change_svg_attribute_differences_aux(Stream,SvgRowID,'bgcolor',RowColor),
3284
3285		% previous value:
3286		ajoin(['bVarPrev_',ID],SvgPrevID),
3287		change_svg_attribute_differences_aux(Stream,SvgPrevID,'text',PrevResValCodes),
3288
3289		fail.
3290		visb_visualise_function_aux(Stream,Options,_,StateId,_,_,_,_) :-
3291		member(show_events(OpList),Options),
3292		get_state_value_enabled_operation_status(StateId,OpID,Enabled,ResValCodes,TransStr),
3293		show_var_in_visb(OpList,OpID),
3294		ajoin(['bOperation_',OpID],SvgID),
3295		\+ last_attribute_values(SvgID,'text',ResValCodes),
3296		retractall(last_attribute_values(SvgID,'text',_)),
3297		assertz(last_attribute_values(SvgID,'text',ResValCodes)),
3298		format(Stream,' {id: "~w", attr: "text", val: "~s"},~n',[SvgID,ResValCodes]),
3299		(Enabled=true -> BGCol=white ; BGCol='#f1f1f1'),
3300		format(Stream,' {id: "row_~w", attr: "bgcolor", val: "~s"},~n',[SvgID,BGCol]),
3301		escape_value_to_codes_for_js(TransStr,ETS),
3302		format(Stream,' {id: "name_~w", attr: "text", val: "~s"},~n',[SvgID,ETS]),
3303		% TO DO: highlight next event in trace, but then function needs one more parameter
3304		fail.
3305		visb_visualise_function_aux(Stream,Options,Len,_,_,Nr,_,_) :-
3306		(Len>1, member(show_sequence_chart,Options)
3307		-> format(Stream,' {id: "seq_chart_~w", attr: "style", val: "display:block"},~n',[Nr]),
3308		(Nr>1
3309		-> PNr is Nr-1, format(Stream,' {id: "seq_chart_~w", attr: "style", val: "display:none"},~n',[PNr])
3310		; gen_seq_charts_setup(Stream,Len))), % all sequence charts except the first should be invisible
3311		fail.
3312		visb_visualise_function_aux(Stream,_,Len,_,_,Nr,_,_) :-
3313		Nr == Len ->
3314		format(Stream,' ]~n',[])
3315		; format(Stream,' ],~n',[]).
3316
3317		gen_seq_charts_setup(_,Len) :- Len<2, !.
3318		gen_seq_charts_setup(Stream,Len) :-
3319		format(Stream,' {id: "seq_chart_~w", attr: "style", val: "display:none"},~n',[Len]),
3320		NLen is Len-1,
3321		gen_seq_charts_setup(Stream,NLen).
3322
3323		escape_value_to_codes_for_js(Atom,ECodes) :- atom(Atom),
3324		atom_codes(Atom,Codes), b_string_escape_codes(Codes,ECodes).
3325
3326		change_svg_attribute_differences_aux(Stream,ID,Attr,ValueCodes) :-
3327		(last_attribute_values(ID,Attr,ValueCodes)
3328		-> true
3329		; retractall(last_attribute_values(ID,Attr,_)),
3330		assertz(last_attribute_values(ID,Attr,ValueCodes)),
3331		format(Stream,' {id: "~w", attr: "~w", val: "~s"},~n',[ID,Attr,ValueCodes])
3332		).
3333
3334
3335		% generate JS script to register hovers
3336	?	gen_registerHovers_scipt(Stream,Options) :- \+ visb_has_hovers(_),
3337		nonmember(debugging_hovers,Options),
3338		!, % no hover exists
3339		format(Stream,' <script> function registerHovers() {} </script>~n',[]).
3340		gen_registerHovers_scipt(Stream,Options) :-
3341		(member(debugging_hovers,Options) -> GenDebug=true ; GenDebug=false), % gen debugging hovers
3342		% Jquery is no longer required:
3343		%format(Stream,' <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>~n',[]),
3344		format(Stream,' <script>~n',[]),
3345		format(Stream,' function registerHovers() {~n',[]),
3346		format(Stream,' var obj;~n',[]),
3347	?	visb_has_hovers(SVGID), % only generate hover function if necessary; TODO: examine other IDs for GenDebug
3348		opt_add_svg_id_prefix(SVGID,SVGID2),
3349		format(Stream,' obj = document.getElementById("~w");~n',[SVGID2]),
3350		format(Stream,' obj.onmouseover = function(ev){~n',[]),
3351	?	(visb_hover(SVGID,ID,Attr,EnterVal,_,_),
3352		opt_add_svg_id_prefix(ID,ID2),
3353		(GenDebug=false -> true
3354		; format(Stream,' setAttr("~w","~w","SVG ID: ~w")~n',[visb_debug_messages,text,SVGID2])),
3355		format(Stream,' setAttr("~w","~w","~w")~n',[ID2,Attr,EnterVal]), fail ;
3356		format(Stream,' };~n',[])
3357		),
3358		format(Stream,' obj.onmouseout = function(){~n',[]),
3359	?	(visb_hover(SVGID,ID,Attr,_,LeaveVal,_),
3360		opt_add_svg_id_prefix(ID,ID2),
3361		(GenDebug=false -> true
3362		; format(Stream,' setAttr("~w","~w","~w")~n',[visb_debug_messages,text,'...'])
3363		),
3364		format(Stream,' setAttr("~w","~w","~w")~n',[ID2,Attr,LeaveVal]), fail ;
3365		format(Stream,' };~n',[])
3366		),
3367		fail.
3368		gen_registerHovers_scipt(Stream,_) :-
3369		format(Stream,' }~n </script>~n',[]).
3370
3371
3372		% ----------------------------------
3373
3374
3375		generate_visb_html_for_history_with_source(File) :-
3376		generate_visb_html_for_history(File,
3377		[show_constants(all),show_sets(all),show_variables(all),show_events(all),show_invariants,show_source]).
3378		generate_visb_html_for_history_with_vars(File) :-
3379		generate_visb_html_for_history(File,[show_constants(all),show_sets(all),show_variables(all),show_events(all)]).
3380		generate_visb_html_for_history(File) :-
3381		generate_visb_html_for_history(File,[]).
3382		generate_visb_html_for_history(File,Options) :-
3383		start_ms_timer(Timer),
3384		get_state_id_trace(T),
3385		T = [root|StateIds],
3386		set_unicode_mode,
3387		call_cleanup(get_action_trace_with_limit(120,Actions), % TODO: also get description of JSON traces
3388		unset_unicode_mode),
3389		reverse(Actions,FActions),
3390		combine_state_and_actions(StateIds,[root|StateIds],FActions,List),
3391		generate_visb_html(List,File,Options),
3392		stop_ms_walltimer_with_msg(Timer,'exporting history to VisB HTML file: ').
3393
3394
3395		combine_state_and_actions([],_,[],[]).
3396		combine_state_and_actions([StateId|TS],[PrevId|TP],[action(ActionStr,ATerm)|TA],
3397		[change_to_state_via_action(StateId,ActionStr,Desc)|TRes]) :-
3398		(get_operation_description_for_transition(PrevId,ATerm,StateId,D) -> Desc=D ; Desc=''),
3399		combine_state_and_actions(TS,TP,TA,TRes).
3400
3401		generate_visb_html_for_current_state(File) :-
3402		generate_visb_html_for_current_state(File,[show_variables(all)]).
3403		generate_visb_html_for_current_state(File,Options) :-
3404		start_ms_timer(Timer),
3405		current_state_id(ID),
3406		generate_visb_html([ID],File,Options),
3407		stop_ms_walltimer_with_msg(Timer,'exporting current state to VisB HTML file: ').
3408		generate_visb_html_codes_for_states(StateIds,Options,Codes) :-
3409		generate_visb_html_to_codes(StateIds,Options,Codes). % write to codes list
3410
3411		% ------------------------------
3412
3413
3414		show_typed_var_in_visb(all,_) :- !.
3415		show_typed_var_in_visb(VarList,b(identifier(ID),_,_)) :- !, show_var_in_visb(VarList,ID).
3416		show_var_in_visb(VarList,ID ) :- (VarList=all -> true ; member(ID,VarList) -> true).
3417
3418		% generate a table for the state (we could use bvisual2)
3419		gen_state_table(Stream,Options,StateIds) :-
3420		b_or_z_mode,
3421		member(show_variables(VarList),Options),
3422		b_get_machine_variables(TypedVars),
3423		% is this useful if Len > 1, but StateIds are not from a trace? (see also below for formulas)
3424		(length(StateIds,Len), Len > 1 -> NOptions = [show_prev_value|Options] ; NOptions = Options),
3425		gen_state_table_aux(Stream,NOptions,'Variables',TypedVars,VarList,[],'Value','bVar_'),fail.
3426		gen_state_table(Stream,Options,StateIds) :-
3427		b_or_z_mode,
3428		member(show_variables(VarList),Options),
3429		b_get_machine_expressions(AExprs,Options), AExprs \= [],
3430		(length(StateIds,Len), Len > 1 -> NOptions = [show_prev_value|Options] ; NOptions = Options),
3431		gen_state_table_aux(Stream,NOptions,'Formulas',AExprs,VarList,[],'Value','bVar_'),fail.
3432		gen_state_table(Stream,Options,StateIds) :-
3433		b_or_z_mode,
3434	?	member(show_constants(IDList),Options),
3435		b_get_machine_constants(TypedVars),
3436		last(StateIds,Last), % we assume there is only one constant valuation in the trace; TO DO: generalise
3437		get_state_and_action(Last,LastId,_,_),
3438		visited_expression(LastId,BState),
3439		expand_to_constants_and_variables(BState,ConstState,_),
3440		gen_state_table_aux(Stream,Options,'Constants',TypedVars,IDList,ConstState,'Value','bConstant_'),fail.
3441		gen_state_table(Stream,Options,_) :-
3442		b_or_z_mode,
3443	?	member(show_sets(IDList),Options),
3444		findall(TSet,bv_top_level_set(TSet,_),TypedVars),
3445		findall(bind(Set,Val),(bv_top_level_set(TSet,Val),get_texpr_id(TSet,Set)),BState),
3446		gen_state_table_aux(Stream,Options,'Sets',TypedVars,IDList,BState,'Value','bSet_'),fail.
3447		% TO DO: maybe show also top-level guards specfile_possible_trans_name or get_top_level_guard
3448		gen_state_table(Stream,Options,_StateIds) :-
3449		b_or_z_mode,
3450		member(show_events(IDList),Options),
3451		get_specification_description(operations,SN),
3452		atom_tail_to_lower_case(SN,SectionName),
3453		findall(b(identifier(OpName),subst,[]),b_top_level_operation(OpName),TypedVars),
3454		% TODO: op(Params,Results) instead of subst
3455		gen_state_table_aux(Stream,Options,SectionName,TypedVars,IDList,[],'Enabled','bOperation_'),fail.
3456		gen_state_table(Stream,Options,StateIds) :-
3457		xtl_mode,
3458		(length(StateIds,Len), Len > 1 -> NOptions = [show_prev_value|Options] ; NOptions = Options),
3459		bv_get_top_level(IDs),
3460		findall(b(identifier(ID),string,[]), member(ID,IDs), Props),
3461		gen_state_table_aux(Stream,NOptions,'Properties',Props,IDs,[],'Value','bVar_'), fail.
3462		gen_state_table(_Stream,_,_).
3463
3464
3465		gen_source_code_section(Stream,Options) :-
3466		member(show_source,Options), % we could also include original sources, rather than just internal rep.
3467		!,
3468		Section = 'Source',
3469		format(Stream,' <button type="button" class="collapsible collapsible-style" title="Inspect source code of internal representation of ProB of model">~w</button>~n',[Section]),
3470		format(Stream,'<div class="coll-content-hid">~n',[]),
3471		get_internal_representation(PP),
3472		format(Stream,'<pre>~s</pre>~n',[PP]),
3473		format(Stream,'</div>~n',[]).
3474		gen_source_code_section(_Stream,_).
3475
3476
3477		% creates a HTML table with header name Section and including one row per ID in TypedVars;
3478		% id of value for ID is prefixed with IDPrefix
3479		% VarListToShow is either all or a list of ids
3480		gen_state_table_aux(Stream,Options,Section,TypedVars,VarListToShow,BState,ValueStr,IDPrefix) :-
3481		include(show_typed_var_in_visb(VarListToShow),TypedVars,SVars), % check which ids should be shown
3482		length(SVars,SLen), SLen>0,
3483		length(TypedVars,Len),
3484		(SLen=Len
3485		-> format(Stream,' <button type="button" class="collapsible collapsible-style">~w (~w)</button>~n',[Section,SLen])
3486		; format(Stream,' <button type="button" class="collapsible collapsible-style">~w (~w/~w)</button>~n',
3487		[Section,SLen,Len])
3488		),
3489		format(Stream,'<div class="coll-content-hid">~n',[]),
3490	?	(member(show_prev_value,Options) % add extra column for previous value of variables (and animation expressions)
3491		-> format(Stream,' <table> <tr> <th>Nr</th> <th>Name</th> <th>Value</th> <th>Previous Value</th> </tr>~n',[])
3492		; format(Stream,' <table> <tr> <th>Nr</th> <th>Name</th> <th>~w</th> </tr>~n',[ValueStr])),
3493	?	( nth1(Nr,SVars,IDorExprToShow),
3494		get_state_table_name_and_expr(IDorExprToShow,ID,LongID,TExpr),
3495	?	(get_state_value_codes_for_id(BState,ID,Options,_,ValCodes)
3496		-> html_escape_codes(ValCodes,EVC) % Value provided in BState; may be overriden in trace export
3497		; EVC = "?"),
3498		get_table_hover_message_codes(ID,TExpr,HoverMsgC),
3499	?	(member(show_prev_value,Options) % add previous value of variables (and animation expressions)
3500		-> % for variables the values are added later in JS
3501		% do we want to show the previous value in the state only HTML?
3502		format(Stream,'~n <tr id="row_~w~w" title="~s"> <td>~w</td> <td id="name_~w~w">~w</td> <td id="~w~w">?</td> <td id="bVarPrev_~w">?</td> </tr>~n',
3503		[IDPrefix,ID, HoverMsgC, Nr, IDPrefix,ID,LongID, IDPrefix,ID, ID ])
3504		;
3505		format(Stream,'~n <tr id="row_~w~w" title="~s"> <td>~w</td> <td id="name_~w~w">~w</td> <td id="~w~w">~s</td> </tr>~n',
3506		[IDPrefix,ID, HoverMsgC, Nr, IDPrefix,ID,LongID, IDPrefix,ID,EVC])),
3507		fail
3508		;
3509		format(Stream,' </table>~n </div>~n',[])
3510		).
3511
3512		%get_state_table_name_and_expr(bexpr(Kind,TExpr),Name,LongName,Expr) :- !, % we have special expression to show
3513		% Name=Kind,LongName=Kind,Expr=TExpr.
3514		get_state_table_name_and_expr(bexpr(Kind,TExpr),ID,LongName,Expr) :- !, % we have special expression to show
3515		ID=Kind, % ID for SVG updates, ...
3516		translate_bexpression_with_limit(TExpr,200,TS),
3517		ajoin([Kind,' == ',TS],LongName),
3518		Expr=TExpr.
3519		get_state_table_name_and_expr(TID,ID,ID,TID) :- get_texpr_id(TID,ID). % normal case: variable name
3520
3521
3522		visb_machine_animation_expression(variant,AEName,Variant,_) :-
3523		b_get_operation_variant(Name,ConvOrAnt,Variant),
3524		ajoin(['Variant for ',Name, ' (',ConvOrAnt,')'],AEName).
3525		visb_machine_animation_expression(animation_expression,Name,TExpr,_) :-
3526		b_get_machine_animation_expression(Name,TExpr).
3527		visb_machine_animation_expression(invariant,Name,TPred,Options) :-
3528		member(show_invariants,Options),
3529		b_nth1_non_ignored_invariant(Nr,TPred,_),
3530		ajoin(['INVARIANT-',Nr],Name).
3531		% TODO: we should also adapt get_state_value_change to return true when invariant_violated is false for the state
3532		% we could also only include this section when there is an invariant violation in the trace?
3533
3534		b_get_machine_expressions(List,Options) :-
3535		findall(bexpr(AE_Name,AExpr),visb_machine_animation_expression(_,AE_Name,AExpr,Options),List).
3536		% 'ANIMATION_EXPRESSION' or invariants or variants
3537
3538
3539		% get hover message for entries in variables/constants/... rows:
3540		get_table_hover_message_codes(ID,TExpr,EscHoverMsg) :-
3541		get_texpr_type(TExpr,Type),
3542		(Type=subst,b_get_machine_operation_signature(ID,TS)
3543		-> ajoin(['Operation: ',TS],HoverMsg)
3544		; pretty_type(Type,TS),
3545		(get_texpr_description(TExpr,Desc)
3546		-> ajoin(['Type: ',TS,'\nDesc: ',Desc],HoverMsg)
3547		; ajoin(['Type: ',TS],HoverMsg)
3548		)
3549		),
3550		atom_codes(HoverMsg,HoverCodes),
3551		html_escape_codes(HoverCodes,EscHoverMsg).
3552
3553		% get the values that should be displayed in the variables table
3554		get_state_value_change(StateId,State,ID,Options,ECodes) :-
3555		extract_variables_from_state(State,VariableBState),
3556	?	( get_state_value_codes_for_id(VariableBState,ID,Options,Val,ValCodes) % look up variable values
3557		; visb_machine_animation_expression(_,_,_,Options) ->
3558		state_corresponds_to_fully_setup_b_machine(State,FullState),
3559		get_state_value_codes_for_anim_expr(StateId,FullState,ID,Options,Val,ValCodes) % evaluate animation expressions
3560		),
3561		escape_if_necessary(Val,ValCodes,ECodes). % change " to \" for JavaScript
3562		% formatsilent('Value for ~w~nunescaped: "~s",~n escaped: "~s"~n',[ID,ValCodes,ECodes]).
3563
3564		% avoid unnecessary escaping traversals:
3565		escape_if_necessary([],ValCodes,Res) :- !, Res=ValCodes.
3566		escape_if_necessary(int(_),ValCodes,Res) :- !, Res=ValCodes.
3567		escape_if_necessary(pred_true,ValCodes,Res) :- !, Res=ValCodes.
3568		escape_if_necessary(pred_false,ValCodes,Res) :- !, Res=ValCodes.
3569		escape_if_necessary(_,ValCodes,ECodes) :- b_string_escape_codes(ValCodes,ECodes).
3570
3571
3572		get_state_value_codes_for_id(BState,ID,Options,Val,ValCodes) :-
3573	?	member(bind(ID,Val),BState),
3574		translate_values_for_state_table(Val,Options,ValCodes).
3575
3576		% translate a value for display in state table (not yet escaped)
3577		translate_values_for_state_table(Val,Options,ValCodes) :-
3578		(member(limit_for_values(Nr),Options)
3579		-> translate_bvalue_to_codes_with_limit(Val,Nr,ValCodes)
3580		; get_preference(expand_avl_upto,Max), Max<0
3581		-> translate_bvalue_to_codes(Val,ValCodes) % unlimited
3582		; translate_bvalue_to_codes_with_limit(Val,10000,ValCodes)
3583		).
3584
3585
3586		get_state_value_codes_for_anim_expr(StateId,BState,AE_Name,Options,ResValue,ValCodes) :-
3587		visb_machine_animation_expression(Kind,AE_Name,AExpr,Options),
3588		(Kind=invariant
3589		-> ((invariant_not_yet_checked(StateId) ; invariant_violated(StateId))
3590		-> (safe_create_texpr(convert_bool(AExpr),boolean,TExpr),
3591		evaluate_visb_formula(TExpr,AE_Name,'',BState,ResValue,unknown)
3592		-> translate_pred_val(ResValue,ValCodes)
3593		; ResValue=pred_unknown, ValCodes = "?" % WD error?
3594		)
3595		; ResValue=pred_true, translate_pred_val(pred_true,ValCodes) % no need to evaluate invariant
3596		)
3597		; evaluate_visb_formula(AExpr,AE_Name,'',BState,ResValue,unknown),
3598		translate_values_for_state_table(ResValue,Options,ValCodes)
3599		).
3600		translate_pred_val(pred_true,[8868]). % see translate:unicode_translation(truth,X).
3601		translate_pred_val(pred_false,[8869]). % see translate:unicode_translation(falsity,X).
3602
3603
3604		get_state_value_enabled_operation_status(StateId,OpName,Enabled,EnabledValue,TransStr) :-
3605		b_top_level_operation(OpName),
3606		findall(TransID, (transition(StateId,OpTerm,TransID,_NewStateId),
3607		match_operation(OpTerm,OpName)), TransList),
3608		length(TransList,Len),
3609		(Len>0
3610		-> Enabled=true,
3611		EnabledValue = "\x2705\", % green check mark, TRUE alternatives \x2705\ \x2713\ \x2714\
3612		(TransList=[TID], transition(StateId,OpTerm,TID,NewStateId),
3613		translate_event_with_src_and_target_id(OpTerm,StateId,NewStateId,200,TransStr)
3614		-> true
3615		; ajoin([OpName,' (',Len,'\xd7\)'],TransStr) %
3616		)
3617		; time_out_for_node(StateId,OpName,TypeOfTimeOut) ->
3618		Enabled=TypeOfTimeOut,
3619		EnabledValue = [8987], % four o'clock symbol
3620		TransStr = OpName
3621		%ajoin(['No transition found due to: ',TypeOfTimeOut],HoverMsg)
3622		; get_preference(maxNrOfEnablingsPerOperation,0) ->
3623		Enabled=not_computed,
3624		EnabledValue = [10067], % red question mark
3625		TransStr = OpName
3626		%'No transitions were computed because MAX_OPERATIONS = 0' = HoverMsg
3627		; b_get_machine_operation_max(OpName,0) ->
3628		Enabled=not_computed,
3629		EnabledValue = [10067], % red question mark
3630		TransStr = OpName
3631		%ajoin(['No transitions were computed because MAX_OPERATIONS_',OpName,' = 0'],HoverMsg)
3632		; Enabled=false,
3633		EnabledValue = [9940], % stop sign, FALSE, alternatives \x10102\
3634		TransStr = OpName
3635		%ajoin(['Not enabled'],HoverMsg)
3636		). % TO DO: show whether this is the next step in the trace
3637
3638		% --------------------------
3639
3640		% debugging features to inspect all created SVG objects
3641		tcltk_get_visb_objects(list([Header|AllObjects])) :-
3642		Header = list(['SVG-ID','svg_class','Attribute','Value']),
3643		findall(list([SvgID,SvgClass,Attr,Value]),
3644		(visb_svg_obj_with_parent(SvgID,SvgClass,AttrList,true),
3645		(member(svg_attribute(Attr,Value),AttrList) ;
3646		visb_svg_parent(SvgID,Value), Attr=children)
3647		), Childs),
3648		findall(list([SvgID,SvgClass,Attr,Value]),
3649		(visb_svg_obj_with_parent(SvgID,SvgClass,AttrList,false),
3650		member(svg_attribute(Attr,Value),AttrList)
3651		),AllObjects, Childs).
3652
3653		% debugging features to inspect all created SVG objects
3654		tcltk_get_visb_hovers(list([Header|AllObjects])) :-
3655		Header = list(['SVG-ID','ID','Attribute','EnterValue', 'ExitValue']),
3656		findall(list([SvgID,ID,Attr,EnterVal,ExitVal]),
3657		visb_hover(SvgID,ID,Attr,EnterVal,ExitVal,_Pos), AllObjects).
3658
3659		% debugging features to inspect items
3660		tcltk_get_visb_items(Res) :-
3661		current_state_id(ID),
3662		tcltk_get_visb_items(ID,Res).
3663		tcltk_get_visb_items(_StateId,Res) :-
3664		\+ visb_file_is_loaded(_),!,
3665		Res = list(['No VisB JSON file loaded']).
3666		tcltk_get_visb_items(StateId,list([Header|AllItems])) :-
3667		Header = list(['SVG-ID','Attribute','Value']),
3668		get_preference(translation_limit_for_table_commands,Limit),
3669		findall(list([SvgID,SvgAttribute,Val]),
3670		get_change_attribute_for_state(StateId,SvgID,SvgAttribute,Val),
3671		Items),
3672		findall(list([DefID,'VisB Definition',DValS]),
3673		(get_expanded_bstate(StateId,ExpandedBState),
3674		reverse(ExpandedBState,RS),
3675		member(bind(DefID,DVal),RS),
3676		visb_definition(DefID,_,_,_,_,_),
3677		translate_bvalue_with_limit(DVal,Limit,DValS)),
3678		AllItems, Items).
3679
3680		:- use_module(probsrc(translate),[translate_event_with_limit/3]).
3681		tcltk_get_visb_events(Res) :-
3682		current_state_id(ID),
3683		tcltk_get_visb_events(ID,Res).
3684		tcltk_get_visb_events(_StateId,Res) :-
3685		\+ visb_file_is_loaded(_),!,
3686		Res = list(['No VisB JSON file loaded']).
3687		tcltk_get_visb_events(StateId,list([Header|AllItems])) :-
3688		Header = list(['SVG-ID','Event','Target']),
3689		get_preference(translation_limit_for_table_commands,Limit),
3690		findall(list([SvgID,EventStr,NewStateId]),
3691		(perform_visb_click_event(SvgID,[],StateId,_Event,OpTerm,NewStateId,Res),
3692		(Res=[] -> EventStr='disabled' ; translate_event_with_limit(OpTerm,Limit,EventStr))
3693		),
3694		AllItems).
3695		% --------------------------
3696
3697		% for ProB2-UI
3698
3699		:- use_module(probsrc(translate),[translate_bexpression_with_limit/3]).
3700		get_visb_items(List) :-
3701		findall(visb_item(SvgID,Attr,TS,Desc,Pos),
3702		(visb_item(SvgID,Attr,TypedExpr,_Used,Desc,Pos,_),
3703		translate_bexpression_with_limit(TypedExpr,1000,TS)), List).
3704
3705		get_visb_attributes_for_state(StateId,List) :-
3706		% some external functions like ENABLED are evaluated in current state; it might be useful to set_current_state
3707		(visb_file_is_loaded(_) -> true
3708		; add_warning(visb_visualiser,'No VisB visualisation loaded, cannot get attributes for state: ',StateId)),
3709		findall(set_attr(SvgID,SvgAttribute,Val),
3710		get_change_attribute_for_state(StateId,SvgID,SvgAttribute,Val),
3711		List).
3712
3713		% for ProB2-UI
3714		get_visb_click_events(List) :-
3715		findall(execute_event(SvgID,Event,Preds),
3716		get_visb_event(SvgID,Event,Preds), List).
3717		get_visb_event(SvgID,Event,Preds) :- visb_event(SvgID,Event,Preds,_,_File,_Pos).
3718		get_visb_event(SvgID,'',[]) :- % add a virtual empty event for SVG Ids with hovers but no events
3719		visb_has_hovers(SvgID),
3720		\+ visb_event(SvgID,_,_,_,_File,_Pos).
3721
3722
3723		:- use_module(probsrc(state_space), [extend_trace_by_transition_ids/1]).
3724		% perform a click on a VisB SVG ID in the animator
3725		tcltk_perform_visb_click_event(SvgID) :- current_state_id(StateId),
3726		(perform_visb_click_event(SvgID,[],StateId,TransitionIDs)
3727		-> formatsilent('Clicking on ~w in state ~w resulted in transition id sequence ~w~n',[SvgID,StateId,TransitionIDs]),
3728		extend_trace_by_transition_ids(TransitionIDs)
3729		; add_error(visb_visualiser,'Cannot perform VisB click on: ',SvgID)
3730		).
3731
3732		% computes the effect of clicking on an SvgID in StateId
3733		% it returns either empty list if the visb_event is not feasible or a list of transition ids
3734		% it fails if SvgID has no events associated with it
3735		perform_visb_click_event(SvgID,MetaInfos,StateId,ResTransitionIds) :-
3736		perform_visb_click_event(SvgID,MetaInfos,StateId,_,_,_,ResTransitionIds).
3737		perform_visb_click_event(SvgID,MetaInfos,StateId,OpName,OpTerm,NewStateId,ResTransitionIds) :-
3738		get_expanded_bstate(StateId,ExpandedBState),
3739		set_error_context(checking_context('VisB:','performing click event')),
3740		set_context_state(StateId,perform_visb_click_event),
3741		get_svgid_with_events(SvgID,_),
3742		call_cleanup(perform_aux(SvgID,StateId,ExpandedBState,OpName,OpTerm,NewStateId,ResTransitionIds,MetaInfos),
3743		(clear_context_state,clear_error_context)).
3744
3745		get_svgid_with_events(SvgID,FirstOpName) :- visb_event(SvgID,FirstOpName,_,_,_File,_Pos).
3746
3747
3748		:- use_module(probsrc(tools),[safe_read_term_from_atom/2]).
3749		:- use_module(probsrc(state_space),[transition/4]).
3750		perform_aux(SvgID,StateId,_ExpandedBState,OpName,OpTerm,NewStateId,ResTransitionIds,_MetaInfos) :-
3751		\+ b_or_z_mode,
3752		% just look up transition/4 entries in state space
3753		% TODO: maybe provide this possibility for B models, even if using explicit parameter values is more robust
3754		get_visb_event_operation(SvgID,OpName,Preds,_Pred,Pos),
3755		safe_read_term_from_atom(OpName,OpTerm0),
3756		(xtl_mode -> check_xtl_direct_transition_candidate(OpTerm0,Preds,Pos), OpTerm=OpTerm0 ; true), !,
3757		% for XTL: use exec by pred for arity 0, otherwise try to find transition term in state space
3758		if((transition(StateId,OpTerm,TransID,NewStateId),
3759		match_operation(OpTerm,OpName)), % match is relevant if \+xtl_mode
3760		ResTransitionIds = [TransID],
3761		return_disabled(SvgID,StateId,OpName,OpTerm,NewStateId,ResTransitionIds)
3762		).
3763		perform_aux(SvgID,StateId,ExpandedBState,OpName,OpTerm,NewStateId,ResTransitionIds,MetaInfos) :-
3764		%state_space:portray_state_space,
3765		if(execute_visb_event_by_predicate(SvgID,StateId,ExpandedBState,OpName,OpTerm,NewStateId,TransIds,MetaInfos),
3766		ResTransitionIds = TransIds,
3767		return_disabled(SvgID,StateId,OpName,OpTerm,NewStateId,ResTransitionIds)).
3768
3769		check_xtl_direct_transition_candidate(OpTerm,Preds,Pos) :-
3770		nonvar(OpTerm), % upper case event names are interpreted as Prolog variables -> use exec by pred (or FIXME)
3771		functor(OpTerm,_,Ar), Ar>0, % use exec by pred for arity 0, otherwise try to find transition term in state space
3772		(Preds \= []
3773		-> add_warning(visb_visualiser,'Ignoring predicates for VisB XTL event with explicit transition term (use predicate to provide parameter values): ',OpTerm,Pos)
3774		; true).
3775
3776		return_disabled(SvgID,StateId,OpName,OpTerm,NewStateId,ResTransitionIds) :-
3777		OpTerm = disabled, NewStateId = StateId,
3778		get_svgid_with_events(SvgID,OpName),
3779		ResTransitionIds = []. % visb_event not enabled
3780
3781		:- use_module(probsrc(tools_strings),[match_atom/2]).
3782		:- use_module(probsrc(specfile),[get_operation_name/2]).
3783		match_operation(OpTerm,OpTerm) :- !.
3784		match_operation(OpTerm,OpName) :- atom(OpName),
3785		(get_operation_name(OpTerm,OpName)
3786		; match_atom(OpName,OpTerm) % match an atom string with a compound term
3787		),!.
3788
3789		execute_visb_event_by_predicate(SvgID,StateId,ExpandedBState,OpName,OpTerm,NewStateId,TransIds,MetaInfos) :-
3790		get_visb_event_operation(SvgID,OpName,_,Pred,Pos),
3791		build_visb_click_meta_object(MetaInfos,BMetaInfos),
3792		bsyntaxtree:replace_id_by_expr(Pred,'VISB_CLICK_META_INFOS',BMetaInfos,NPred),
3793		exec_aux(SvgID,StateId,ExpandedBState,OpName,NPred,Pos,OpTerm,NewStateId,TransIds).
3794
3795		build_visb_click_meta_object(MetaInfos,BMetaInfos) :-
3796		(member(alt_key,MetaInfos) -> AltKey = pred_true ; AltKey = pred_false),
3797		(member(ctrl_key,MetaInfos) -> CtrlKey = pred_true ; CtrlKey = pred_false),
3798		(member(meta_key,MetaInfos) -> MetaKey = pred_true ; MetaKey = pred_false),
3799		(member(pageX(PageX),MetaInfos) -> true ; PageX = 0), % fallback
3800		(member(pageY(PageY),MetaInfos) -> true ; PageY = 0), % fallback
3801		(member(shift_key,MetaInfos) -> ShiftKey = pred_true ; ShiftKey = pred_false),
3802		findall(','(string(Var),string(VarValue)), member(js_var(Var,VarValue), MetaInfos), JSVars),
3803
3804		visb_click_meta_b_type(BType),
3805		BMetaInfos = b(value(rec([
3806		field(altKey,AltKey),
3807		field(ctrlKey,CtrlKey),
3808		field(jsVars,JSVars),
3809		field(metaKey,MetaKey),
3810		field(pageX,int(PageX)),
3811		field(pageY,int(PageY)),
3812		field(shiftKey,ShiftKey)
3813		])),BType,[visb_generated]).
3814
3815		visb_click_meta_b_type(record([
3816		field(altKey,boolean),
3817		field(ctrlKey,boolean),
3818		field(jsVars,set(couple(string,string))),
3819		field(metaKey,boolean),
3820		field(pageX,integer),
3821		field(pageY,integer),
3822		field(shiftKey,boolean)
3823		])).
3824
3825		:- use_module(probsrc(tcltk_interface),[compute_all_transitions_if_necessary/2]).
3826		:- use_module(library(random),[random_member/2]).
3827		:- use_module(extrasrc(mcts_game_play), [mcts_auto_play/4, mcts_auto_play_available/0]).
3828		:- use_module(probsrc(tools_timeout), [time_out_with_factor_call/3]).
3829		:- use_module(probsrc(external_functions),[call_external_function/7]).
3830		exec_aux(SvgID,StateId,ExpandedBState,OpName,Pred,Pos,OpTerm,NewStateId,[TransId]) :-
3831		(csp_with_bz_mode -> fail % execute by predicate does not work properly yet with csp_and_b states
3832		; b_or_z_mode -> b_is_operation_name(OpName)
3833		; true), !, % note: ignores special definitions below if not B mode
3834		time_out_with_factor_call(
3835		exec_op_by_pred_aux(StateId,ExpandedBState,OpName,Pred,OpTerm,NewState,Pos,TransInfo),
3836		5, % min_max_time_out(10,100,15000)
3837		(ajoin(['TIME-OUT for VisB click on SVG ID ', SvgID,' while executing operation by predicate: '],Msg),
3838		add_warning(visb_visualiser,Msg,OpName,Pos),fail)),
3839		patch_state(NewState,StateId,PatchedNewState),
3840		% add transition to state space:
3841		tcltk_interface:add_trans_id_infos(StateId,OpTerm,PatchedNewState,NewStateId,TransId,TransInfo).
3842		%translate:print_bstate(PatchedNewState),nl.
3843		exec_aux(SvgID,StateId,_ExpandedBState,'MCTS_AUTO_PLAY',_Pred,Pos,OpTerm,NewStateId,[TransId]) :- !,
3844		mcts_auto_play_available,
3845		% TODO: allow to set SimRuns, TimeOut in Pred
3846		add_debug_message(visb_visualiser,'Performing MCTS_AUTO_PLAY for click on: ',SvgID,Pos),
3847		mcts_auto_play(StateId,OpTerm,TransId,NewStateId).
3848		% TODO: more general call via call_external_substitution(FunName,Args,InState,OutState,Info,WF)
3849		exec_aux(_SvgID,StateId,_ExpandedBState,'RANDOM_ANIMATE',_Pred,_Pos,OpTerm,NewStateId,[TransId]) :- !,
3850		compute_all_transitions_if_necessary(StateId,false),
3851		findall(rtr(OpTerm,TransId,NewStateId),transition(StateId,OpTerm,TransId,NewStateId),List),
3852		random_member(rtr(OpTerm,TransId,NewStateId),List).
3853		% see tcltk_interface:tcltk_random_perform2 and allow Kind: fully_random, no_self_loops, heuristics, ...
3854		% split with ; ?
3855		exec_aux(SvgID,StateId,ExpandedBState,'RANDOM_ANIMATE_UNTIL_LTL',LTLExpr,Pos,OpTerm,NewStateId,TransIds) :- !,
3856		OpTerm = 'RANDOM_ANIMATE_UNTIL_LTL',
3857		(get_texpr_type(LTLExpr,string),
3858		evaluate_visb_formula(LTLExpr,'RANDOM_ANIMATE_UNTIL_LTL',SvgID,ExpandedBState,Value,Pos),
3859		Value = string(LTLFormula)
3860		-> tcltk_interface:tcltk_animate_until(LTLFormula,StateId,1000,ltl_state_property,_Steps,_Res,NewStateId,TransIds)
3861		; add_error(visb_visualiser,'Argument to RANDOM_ANIMATE_UNTIL_LTL must provide LTL formula as string:',StateId)
3862		).
3863		exec_aux(SvgID,StateId,ExpandedBState,ExternalFun,ArgEXPR,Pos,OpTerm,NewStateId,TransIds) :-
3864		external_fun_as_special_operation(ExternalFun),!,
3865		NewStateId=StateId, TransIds=[],
3866		evaluate_visb_formula(ArgEXPR,ExternalFun,1,ExpandedBState,ArgValue,Pos),
3867		convert_arg_value_to_list(ArgEXPR,ArgValue,UnEvalArgs,EvaluatedArgs),
3868		OpTerm =.. [ExternalFun|EvaluatedArgs],
3869		debug_format(9,'VisB event for ~w: calling external function ~w with ~w~n',[SvgID,ExternalFun,EvaluatedArgs]),
3870		% Note: we ignore the return value
3871		call_external_function(ExternalFun,UnEvalArgs,EvaluatedArgs,_Value,any,Pos,no_wf_available).
3872
3873		% convert single argument expression to list; better would be to use a predicate with argument names
3874		convert_arg_value_to_list(b(couple(A,B),_,_),(VA,VB),[A|T],[VA|VT]) :- !, convert_arg_value_to_list(B,VB,T,VT).
3875		convert_arg_value_to_list(Arg,Val,[Arg],[Val]).
3876
3877		:- use_module(probsrc(b_state_model_check),[execute_operation_by_predicate_in_state_with_pos/7,
3878		xtl_execute_operation_by_predicate_in_state/8]).
3879		exec_op_by_pred_aux(StateId,ExpandedBState,OpName,Pred,OpTerm,NewState,Pos,TransInfo) :- xtl_mode,!,
3880		visited_expression(StateId,RawState),
3881		xtl_execute_operation_by_predicate_in_state(ExpandedBState,RawState,OpName,Pred,OpTerm,NewState,Pos,TransInfo).
3882		exec_op_by_pred_aux(_StateId,ExpandedBState,OpName,Pred,OpTerm,NewState,Pos,TransInfo) :-
3883		execute_operation_by_predicate_in_state_with_pos(ExpandedBState,OpName,Pred,OpTerm,NewState,Pos,TransInfo).
3884
3885		:- use_module(probsrc(bmachine), [b_is_variable/1,b_machine_has_constants/0]).
3886
3887		is_var_binding(bind(Var,_)) :- b_or_z_mode, b_is_variable(Var).
3888
3889
3890		% remove constants and VisB Definition entries from state:
3891		patch_state(NewState,_StateId,PatchedState) :-
3892		\+ b_or_z_mode, !, PatchedState=NewState. % XTL state is raw state
3893		patch_state(NewState,StateId,PatchedState) :-
3894		get_constants_id_for_state_id(StateId,ConstId),!,
3895		PatchedState = const_and_vars(ConstId,VarsState),
3896		include(is_var_binding,NewState,VarsState).
3897		patch_state(NewState,StateId,VarsState) :-
3898		(b_machine_has_constants
3899		-> add_error(visb_visualiser,'Could not extract constants id for state:',StateId),
3900		VarsState=NewState
3901		; include(is_var_binding,NewState,VarsState)).
3902
3903		% the next predicate gets all operations/events associated with SvgID in the order in which they were found
3904		% note that there is only one visb_event (the last one); all others are auxiliary
3905		get_visb_event_operation(SvgID,OpName,Preds,TypedPred,Pos) :- % check if there are more events registered:
3906		auxiliary_visb_event(SvgID,OpName,Preds,TypedPred,Pos).
3907		get_visb_event_operation(SvgID,OpName,Preds,TypedPred,Pos) :-
3908		visb_event(SvgID,OpName,Preds,TypedPred,_File,Pos).
3909
3910		% ---------------
3911
3912		get_visb_hovers(List) :-
3913		findall(hover(SvgID,ID,Attr,EnterVal,ExitVal),
3914		visb_hover(SvgID,ID,Attr,EnterVal,ExitVal,_), List).
3915
3916		get_visb_svg_objects(List) :-
3917		% TODO: remove objects inlined in get_visb_default_svg_file_contents
3918		topological_sort_svg_objects(SvgIDs),
3919		findall(visb_svg_object(SvgID,SvgClass,AttrList),
3920		(member(SvgID,SvgIDs),
3921		visb_svg_obj_with_parent(SvgID,SvgClass,AttrList,_)), List).
3922
3923		visb_svg_obj_with_parent(SvgID,SvgClass,AttrList,IsChild) :-
3924		visb_svg_object(SvgID,SvgClass,List,_Desc,_Pos),
3925		(visb_svg_child(SvgID,ParentId)
3926		-> IsChild=true, AttrList = [svg_attribute(parentId,ParentId)|List] % add parentId attribute for ProB2-UI
3927		; IsChild=false, AttrList = List).
3928
3929
3930		:- use_module(probsrc(tools),[top_sort/3]).
3931		:- use_module(library(ugraphs),[vertices_edges_to_ugraph/3]).
3932		topological_sort_svg_objects(SortedSVGObjects) :-
3933		findall(SvgID,visb_svg_object(SvgID,_,_,_,_),Vertices),
3934		findall(V-W,visb_svg_parent(V,W),Edges),
3935		vertices_edges_to_ugraph(Vertices,Edges,Graph),
3936		(top_sort(Graph,SortedSVGObjects,UnsortedNr)
3937		-> (UnsortedNr = 0 -> true
3938		; add_warning(visb_visualiser,'Cycle in SVG_OBJECTS parent/child graph, unsorted objects: ',UnsortedNr)
3939		)
3940		; SortedSVGObjects=Vertices,
3941		add_error(visb_visualiser,'Topological sorting of SVG_OBJECTS failed: ',Vertices)
3942		).
3943
3944		% ------------------
3945
3946		:- use_module(probsrc(bmachine),[b_absolute_file_name_relative_to_main_machine/2]).
3947		extended_static_check_default_visb_file :-
3948		(get_default_visb_file(VisBFile,Pos)
3949		% TODO: we could check if we have an visb_history(JSONFile,_,_) option
3950		-> extended_static_check_visb_file(VisBFile,Pos)
3951		; true).
3952
3953		extended_static_check_visb_file('',_InclusionPos) :- !,
3954		load_visb_file('').
3955		extended_static_check_visb_file(VisBFile,InclusionPos) :-
3956		b_absolute_file_name_relative_to_main_machine(VisBFile,AFile),
3957		(file_exists(AFile)
3958		-> load_visb_file(AFile)
3959		; add_warning(lint,'VISB_JSON_FILE does not exist: ',AFile,InclusionPos)
3960		).
3961
3962		% ---------------------------
3963
3964		% portray all VisB items in DEFINITION B syntax
3965		get_visb_ids(SIds) :-
3966		findall(Id,visb_id(Id),Ids),
3967		sort(Ids,SIds).
3968
3969		visb_id(ID) :- visb_svg_object(ID,_,_,_,_). % see svg_id_exists
3970		visb_id(ID) :- visb_item(ID,_,_,_,_,_,_), \+ visb_svg_object(ID,_,_,_,_).
3971		visb_id(ID) :- visb_event(ID,_,_,_,_,_), \+ visb_svg_object(ID,_,_,_,_).
3972		visb_id(ID) :- visb_hover(ID,_,_,_,_,_), \+ visb_svg_object(ID,_,_,_,_).
3973
3974		:- public portray_visb/0.
3975		portray_visb:-
3976		get_visb_ids(SIds), nth1(Nr,SIds,ID),
3977		%visb_svg_object(ID,SVG_Class,NewRestAttrs,Desc,Pos1),
3978		findall(field(Attr,b(value(StaticVal),any,[])),
3979		(visb_svg_object(ID,SVG_Class,StaticAttrs,Desc,_Pos1),
3980		( Attr=svg_class,StaticVal=string(SVG_Class)
3981		; Attr=comment,StaticVal=string(Desc)
3982		; member(svg_attribute(Attr,StaticVal),StaticAttrs))
3983		),
3984		StaticValues),
3985		findall(field(Attr,TypedExpr),
3986		visb_item(ID,Attr,TypedExpr,_UsedIds,_Desc,_PosStartOfItem,_Meta), % meta can contain override
3987		Updates,StaticValues),
3988		% TODO: incorporate events and hovers
3989		UpdateRec = b(rec(Fields),any,[]),
3990		gen_string(ID,IDS),
3991		Fields = [field(id,IDS) | Updates],
3992		(StaticValues=[] -> format('~nVISB_SVG_UPDATES~w == ',[Nr]) ; format('~nVISB_SVG_OBJECTS~w == ',[Nr])),
3993		translate:print_bexpr(UpdateRec), write(';'), nl,
3994		fail.
3995		portray_visb.
3996		gen_string(ID,b(string(ID),string,[])).
3997		% use_module(visbsrc(visb_visualiser)), visb_visualiser:portray_visb.