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