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