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