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