1		% (c) 2009-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2		% Heinrich Heine Universitaet Duesseldorf
3		% This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5
6		:- module(error_manager,[init_error_manager/0,
7		add_warning/2, add_warning/3, add_warning/4,
8		reset_errors/0, clear_wd_errors/0,
9		add_error/2, add_error/3, add_error/4,
10		add_error_and_fail/3, add_error_and_fail/2,
11		add_error_fail/3,
12		add_failed_call_error/1, add_internal_error/2, add_internal_error/4,
13		register_optional_error_or_warning/1, reset_optional_errors_or_warnings/0,
14		assert_true/1,
15		add_debug_message/3, add_debug_message/4,
16		add_msg_warn_or_err/5,
17		add_message/2, add_message/3, add_message/4,
18		add_all_perrors/1, add_all_perrors/2, add_all_perrors/3, add_all_perrors/4,
19		get_perror/4,
20		no_real_perror_occurred/1,
21		get_all_errors/1, tcltk_get_all_errors/4,
22		get_tk_table_position_info/2,
23		get_all_errors_and_reset/1, % call if you want to start with a fresh top-level error scope
24		get_all_errors_with_span_info_and_reset/1, % ditto + obtain location info; excludes messages
25		get_all_errors_with_span_and_context_and_reset/1, % ditt + global context and call stack
26		get_all_errors_and_clear/1,
27		get_error/2, get_error_with_span/3,
28		get_warning/2, check_error_occured/2, check_warning_occured/2,
29		get_error_span_linecol/5, get_error_span_linecol/4,
30		simplify_span/2,
31		tk_get_error_span_linecol_for_main_file/4,
32		register_error_span/2,
33		check_error_span_file_linecol/6,
34		position_is_not_in_main_file/1,
35		error_or_warning_occured/0,
36		real_error_occurred/0, reset_real_error_occurred/0, assert_real_error_occurred/1,
37		warning_occurred/0, % true if a warning was raised
38		wd_error_occured/0,
39		test_error_occurred/1, count_errors_occurred/2,
40		get_total_number_of_errors/1,
41		reset_error_spans/0,
42
43		backup_errors/0, backed_up_error/4,
44
45		set_error_context/1, clear_error_context/0,
46		get_error_context/1, restore_error_context/1,
47		print_error_context/0,
48
49		extract_span_description/2, extract_span_description_with_opts/3,
50		extract_symbolic_label_pos/2, extract_symbolic_label/2,
51		extract_line_col/5, extract_file_line_col/6,
52		extract_all_line_col/5,
53		extract_line_col_for_main_file/5,
54		extract_subsidiary_tail_file_name/2, extract_tail_file_name/2,
55		extract_file_number_and_name/3,
56		extract_additional_description/2, extract_pos_context/4,
57		extract_definition_call_stack/2, extract_definition_call_stack_desc/2,
58		print_error_span/1, print_message_span/1,
59
60		turn_show_error_source_on/0, turn_show_error_source_off/0,
61
62		enter_new_error_scope/1, enter_new_error_scope/2,
63		enter_new_clean_error_scope/1,
64		get_current_error_scope/1,
65		exit_error_scope/2, exit_error_scope/3,
66		error_occurred_at_level/1, specific_event_occurred_at_level/2,
67		%throw_errors_in_scope/3,
68		add_new_event_in_error_scope/1, add_new_event_in_error_scope/2,
69		event_occurred_in_error_scope/1, error_occurred_in_error_scope/0,
70		clear_events_in_error_scope/2, clear_events_in_current_error_scope/1,
71		translate_error_event/2,
72		clear_enumeration_warning_in_error_scope/1,
73		clear_all_errors_in_error_scope/1,
74		call_in_fresh_error_scope_for_one_solution/1,
75		enumeration_warning_occured_in_error_scope/0,
76		is_enumeration_warning_exception/1,
77		abort_error_occured_in_error_scope/0,
78		on_enumeration_warning/2, on_enumeration_warning_with_continue/3,
79		throw_enumeration_warnings_in_current_scope/0,
80		throw_enumeration_warnings_in_scope/3,
81		catch_enumeration_warning_exceptions/2, catch_enumeration_warning_exceptions/3,
82		catch_enumeration_warning_exceptions/4, catch_enumeration_warning_exceptions_and_wd_failures/5,
83		call_with_enumeration_warning/1,
84		observe_enumeration_warnings/2,
85		critical_enumeration_warning_occured_in_error_scope/4,
86		critical_enumeration_warning_occured_in_error_scope/0,
87		virtual_time_out_occured_in_error_scope/1, % variation which returns a virtual_time_out(.) term
88		clear_enumeration_warnings/0,
89		translate_events_in_current_scope_to_warnings/2,
90		time_out_with_enum_warning_one_solution/3, % use this for finding one solution
91		time_out_with_enum_warning_one_solution/4,
92		time_out_with_enum_warning_one_solution_no_new_error_scope/3,
93		is_time_out_result/1,
94		time_out_with_enum_warning_for_findall/3, % use this if you cycle through all solutions
95		time_out_with_enum_warning_for_findall_in_current_error_scope/4,
96		get_virtual_time_out_from_exception/2, % used by time_out_with_enum_warning_for_findall
97		clpfd_overflow_msg/1,
98		is_clpfd_overflow_representation_error/2, is_clpfd_overflow_representation_error_msg/1,
99		logged_error/4,
100		display_error_statistics/0,
101		set_error_manager_silent_mode/1
102		]).
103
104		% meta_predicate annotations should appear before loading any code:
105		:- meta_predicate add_failed_call_error(0).
106		:- meta_predicate add_internal_error(-,:).
107		:- meta_predicate add_new_event_in_error_scope(-,2).
108
109		:- meta_predicate on_enumeration_warning(0,0).
110		:- meta_predicate on_enumeration_warning_with_continue(0,0,0).
111
112		:- meta_predicate catch_enumeration_warning_exceptions(0,0).
113		:- meta_predicate catch_enumeration_warning_exceptions(0,0,-).
114		:- meta_predicate catch_enumeration_warning_exceptions(0,0,-,-).
115		:- meta_predicate catch_enumeration_warning_exceptions_and_wd_failures(0,0,-,0,-).
116
117		:- meta_predicate observe_enumeration_warnings(0,0).
118
119		:- meta_predicate time_out_with_enum_warning_one_solution(0,-,-).
120		:- meta_predicate time_out_with_enum_warning_one_solution(0,-,-,-).
121
122		:- meta_predicate call_in_fresh_error_scope_for_one_solution(0).
123
124		:- meta_predicate call_with_enumeration_warning(0).
125
126		:- meta_predicate time_out_with_enum_warning_one_solution_no_new_error_scope(0,-,-).
127
128		:- meta_predicate time_out_with_enum_warning_for_findall(0,-,-).
129		:- meta_predicate time_out_with_enum_warning_for_findall2(-,0,-,-).
130
131		:- meta_predicate time_out_with_enum_warning_for_findall_in_current_error_scope(-,0,-,-).
132
133		:- meta_predicate assert_true(0).
134		:- meta_predicate catch_wd(-,0,-).
135
136		% ------------
137
138		:- use_module(library(lists)).
139
140		:- use_module(tools,[get_tail_filename/2]).
141		:- use_module(tools_lists,[count_occurences/2]).
142		:- use_module(tools_printing,[print_error/1,print_message_on_stream/3,format_error_with_nl/2,format_with_colour/4]).
143		:- use_module(tools_strings,[ajoin/2, string_concatenate/3, ajoin_with_sep/3]).
144
145		:- use_module(module_information,[module_info/2]).
146		:- module_info(group,infrastructure).
147		:- module_info(description,'The error_manager controls error messages. Error messages can be added, retrieved, counted,etc. The module also takes care of extracting source spans from error messages.').
148
149		%:- use_module(translate).
150		:- use_module(debug, [debug_mode/1, debug_println/1, debug_println/2, debug_format/3]).
151		:- use_module(preferences,[get_preference/2,reset_temporary_preference/2,
152		temporary_set_preference/3]).
153
154
155		:- use_module(extension('counter/counter'),
156		[counter_init/0, new_counter/1, get_counter/2, inc_counter/2, set_counter/2]).
157
158		% cur_block_level is now stored as a C counter, which needs to be initialised
159		init_error_manager :- counter_init, new_counter(cur_block_level).
160
161
162		:- dynamic optional_error_or_warning/1.
163		register_optional_error_or_warning(Type) :-
164		(optional_error_or_warning(Type) -> true ; assertz(optional_error_or_warning(Type))).
165		reset_optional_errors_or_warnings :- retractall(optional_error_or_warning(_)).
166
167		% INTERNAL ERRORS
168
169
170		add_failed_call_error(Call) :- !,
171		add_internal_error('Internal Error; call failed: ',Call).
172
173		add_internal_error(Module,Msg,Term,Span) :-
174		add_error(internal_error(Module),Msg,Term,Span).
175		add_internal_error(Msg,Module:Call) :- !,
176		add_error(internal_error(Module),Msg,Call).
177		add_internal_error(Msg,Call) :-
178		add_error(internal_error(unknown_module),Msg,Call).
179
180
181		% ERROR SCOPING
182
183		%:- dynamic cur_block_level/1.
184		%cur_block_level(0). % no realised as a C counter
185		:- volatile error_occurred_at_level/1.
186		:- dynamic error_occurred_at_level/1.
187		:- volatile throw_error/3.
188		:- dynamic throw_error/3.
189		:- volatile do_not_print_error/2.
190		:- dynamic do_not_print_error/2.
191
192
193		get_current_error_scope(Level) :- get_counter(cur_block_level,Level).
194
195		enter_new_error_scope(Level,_PP) :-
196		enter_new_error_scope(Level). %, tools_printing:print_term_summary(enter(Level,PP)),nl.
197		enter_new_error_scope(Level) :-
198		enter_new_clean_error_scope(Level),
199		L1 is Level - 1,
200		copy_throw_errors(L1,Level).
201		copy_throw_errors(L1,L) :-
202	?	throw_error(L1,Error,Span), %print(copy(throw(L1,L,Error))),nl,
203		assertz(throw_error(L,Error,Span)),fail.
204		copy_throw_errors(L1,L) :-
205	?	do_not_print_error(L1,Error),
206		assertz(do_not_print_error(L,Error)),fail.
207		copy_throw_errors(_,_).
208		enter_new_clean_error_scope(Level) :-
209		inc_counter(cur_block_level,L1),
210		(retract(throw_error(L1,_,_)) -> retractall(throw_error(L1,_,_)) ; true), % DO WE NEED THIS ??
211		(retract(do_not_print_error(L1,_)) -> retractall(do_not_print_error(L1,_)) ; true),
212		% print(enter(L1)),nl,trace,
213		Level=L1.
214
215
216		% mark that everything unifying with Error should be thrown rather than collected
217		throw_errors_in_scope(Level,Error,Span) :-
218		(\+ throw_error(Level,Error,Span) % TO DO: check that we are an instance of existing error !
219		-> assertz(throw_error(Level,Error,Span))
220		; true).
221
222		% state that this event/error should not be printd
223		silent_enum_warnings_in_scope(Level,Critical) :-
224		Error = enumeration_warning(_,_,_,_,Critical),
225		assertz(do_not_print_error(Level,Error)).
226
227		clear_all_errors_in_error_scope(Level) :- %print(clearing(Level)),nl,
228		clear_events_in_error_scope(Level,_),
229		error_occurred_at_level(L1), L1>Level, %print(clearing(L1)),nl,
230		clear_events_in_error_scope(Level,_),fail.
231		clear_all_errors_in_error_scope(_).
232
233		% useful in call_cleanup; when error block may already be exited
234		exit_error_scope_if_necessary(Level,PP) :- get_counter(cur_block_level,CurLevel),
235		(Level =< CurLevel
236		-> exit_error_scope(Level,_,PP) %,print(exit(Level,CurLevel,PP)),nl
237		; true).
238
239		exit_error_scope(Level,ErrorOcc) :- exit_error_scope(Level,ErrorOcc,unknown).
240		exit_error_scope(Level,ErrorOcc,PP) :- get_counter(cur_block_level,CurL),
241		(CurL = Level -> NewL is CurL-1
242		; Level < CurL -> NewL is Level-1,
243		%print_error_scopes,
244		format('*** exiting multiple error blocks (~w -> ~w) for ~w ***~n',[CurL,NewL,PP])
245		; format('*** block ~w already exited (currently at ~w) for ~w ***~n',[Level,CurL,PP]),
246		NewL is CurL
247		), set_counter(cur_block_level,NewL),
248		copy_error_scope_events(CurL,NewL),
249	?	(retract(throw_error(CurL,_,_)) -> retractall(throw_error(CurL,_,_)) ; true),
250	?	(retract(do_not_print_error(CurL,_)) -> retractall(do_not_print_error(CurL,_)) ; true),
251		(retract(error_occurred_at_level(CurL))
252		-> ErrorOcc=true,
253		(error_occurred_at_level(NewL) -> true ; assertz(error_occurred_at_level(NewL)))
254		; ErrorOcc=false).
255		%indent(Level), format('exit level ~w for ~w, cur level ~w, error occ = ~w~n',[Level,PP,CurL,ErrorOcc]).
256
257
258		% versions of enter_new_error_scope and exit_error_scope which re_enter blocks and clean up upon backtracking
259		%enter_new_error_scope_bt(Level,PP) :- enter_new_error_scope(Level,PP), exit_upon_fail(Level,PP).
260		%exit_upon_fail(_,_).
261		%exit_upon_fail(Level,PP) :- print(exit_upon_backtrack(Level,PP)),nl,
262		% exit_error_scope(Level,_,PP),fail.
263		%
264		%exit_error_scope_bt(Level,ErrorOcc,PP) :- exit_error_scope(Level,ErrorOcc,PP).
265		%exit_error_scope_bt(Level,_ErrorOcc,PP) :- print(re_enter_block(Level,PP)),nl,
266		% enter_new_error_scope(Level2,PP),
267		% (Level2=Level -> true ; print(mismatch_when_reentering_block(Level,PP)),nl),
268		% fail.
269
270		% ---------------------------
271
272
273
274		assert_real_error_in_current_block(Source) :- get_counter(cur_block_level,L),L>0,
275		%print(assert_real_error_in_current_block(L)),nl,
276		(specific_event_occurred_at_level(L,Source) -> true
277		; assertz(specific_event_occurred_at_level(L,Source))), % ensures that clear_events_in_current_error_scope does not remove error_occurred_at_level if used for enumeration warnings, ...
278		\+ error_occurred_at_level(L), assertz(error_occurred_at_level(L)),!.
279		assert_real_error_in_current_block(_).
280
281
282		reset_error_scopes :-
283		(set_counter(cur_block_level,0) -> true
284		; format(user_error,'~n*** set_counter(cur_block_level,0) failed!!~n',[]),fail
285		), % try debug random gitlab failures; something really bad happened
286		retractall(error_occurred_at_level(_)),
287		retractall(specific_event_occurred_at_level(_,_)).
288
289		% for debugging / portraying error scopes:
290		% portray_error_scopes
291		:- public print_error_scopes/0.
292		print_error_scopes :-
293		if(get_counter(cur_block_level,L),
294		format(' Cur Block Level = ~w~n',[L]),
295		format(' *** NO Cur Block Level Information !!',[])
296		),
297		fail.
298		print_error_scopes :-
299		findall(L,error_occurred_at_level(L),LL),
300		format(' Errors occured at those levels: ~w~n',[LL]),
301		format(' Specific events at levels:~n',[]),
302		specific_event_occurred_at_level(Level,Err),
303		format(' ~w --> ~w~n',[Level,Err]),
304		fail.
305		print_error_scopes.
306
307		% call a predicate in fresh error scope (assuming one solution is searched for only; failure is also ok)
308		% and then discard all errors
309		call_in_fresh_error_scope_for_one_solution(Call) :-
310		enter_new_error_scope(Level,call_in_fresh_error_scope_for_one_solution),
311		call_cleanup(Call,
312		(clear_all_errors_in_error_scope(_),
313		exit_error_scope(Level,_,call_in_fresh_error_scope_for_one_solution))).
314
315		:- volatile specific_event_occurred_at_level/2.
316		:- dynamic specific_event_occurred_at_level/2.
317
318		% can be used to keep track of whether specific events occurred within an error_scope
319		add_new_event_in_error_scope(Event) :-
320		add_new_event_in_error_scope(Event,do_nothing).
321		do_nothing(_,_).
322		add_new_event_in_error_scope(Event,PrintMessageCall) :-
323		get_counter(cur_block_level,L),
324	?	(specific_event_occurred_at_level(L,Event) -> fail
325	?	; (throw_error(L,Event,Span)
326		-> (debug_mode(off) -> true ; print_message(informational,throwing(Event))), % trace, % <---
327		(do_not_print_error(L,Event), debug_mode(off) -> true ; call(PrintMessageCall,throwing,Span)),
328		% Note: event is not asserted ! See e.g. tests 1089, 1519, 1522, 1661, 1199, 1291, ...
329		throw(Event)
330		; assertz(specific_event_occurred_at_level(L,Event)),
331		(do_not_print_error(L,Event), debug_mode(off) -> true ; call(PrintMessageCall,not_throwing,unknown))
332		)
333		).
334
335		% call if you just want to add the error information; without throwing
336		assert_event_in_error_scope_without_throw(Event) :- get_counter(cur_block_level,L),
337		(specific_event_occurred_at_level(L,Event) -> true
338		; assertz(specific_event_occurred_at_level(L,Event))).
339
340		error_occurred_in_error_scope :- get_counter(cur_block_level,L),error_occurred_at_level(L).
341	?	event_occurred_in_error_scope(Event) :- get_counter(cur_block_level,L),specific_event_occurred_at_level(L,Event).
342
343	?	copy_error_scope_events(FromLevel,ToLevel) :- retract(specific_event_occurred_at_level(FromLevel,Event)),
344	?	\+ specific_event_occurred_at_level(ToLevel,Event),
345		% print(copying_event(FromLevel,ToLevel,Event)),nl,
346		assertz(specific_event_occurred_at_level(ToLevel,Event)), % should we throw if this level demands it ?
347		(throw_error(ToLevel,Event,_Span)
348		-> debug_println(20,throw_copied_event(Event)), throw(Event)),
349		fail.
350		copy_error_scope_events(_,_).
351
352		clear_events_in_current_error_scope(Event) :- get_counter(cur_block_level,L),clear_events_in_error_scope(L,Event).
353
354		%clear_events_in_error_scope(L,Event) :-retract(specific_event_occurred_at_level(L,Event)), print(retract(L,Event)),nl,fail.
355
356		clear_enumeration_warning_in_error_scope(Level) :-
357		clear_events_in_error_scope(Level,enumeration_warning(_,_,_,_,_)).
358
359		clear_events_in_error_scope(L,Event) :-
360	?	(specific_event_occurred_at_level(L,_)
361		-> retractall(specific_event_occurred_at_level(L,Event)),
362	?	(specific_event_occurred_at_level(L,_) -> true % we have not removed all events
363		; retract(error_occurred_at_level(L)) -> true
364		; true
365		)
366		; true). % no errors can have been there
367
368		throw_enumeration_warnings_in_current_scope :-
369		get_counter(cur_block_level,L), throw_enumeration_warnings_in_scope(L,_,unknown).
370
371		throw_enumeration_warnings_in_scope(Level,Critical,Span) :-
372		simplify_span(Span,SimplifiedSpan), % relevant for test 1562
373		throw_errors_in_scope(Level,enumeration_warning(_,_,_,_,Critical),SimplifiedSpan).
374
375		on_enumeration_warning(Call, BackupCall) :-
376	?	on_enumeration_warning_with_continue(Call, BackupCall, true).
377		% sets up a new error scope and forces enumeration_warnings to be thrown
378		% if an enumeration_warning happens the BackupCall is executed
379		on_enumeration_warning_with_continue(Call, _, _) :- is_true_call(Call),!. % happens e.g., for card_for_specific_closure3
380		on_enumeration_warning_with_continue(Call, BackupCall, TrueContinuation) :-
381		enter_new_error_scope(Level,on_enumeration_warning_with_continue),
382		throw_enumeration_warnings_in_scope(Level,_,unknown),
383	?	call_cleanup(
384		catch(
385		if(Call,
386		(exit_error_scope(Level,_,on_enumeration_warning_with_continue_true),
387		% TODO: we need a version that re-instates error_scope upon backtracking?!
388		call(TrueContinuation)),
389		(exit_error_scope(Level,_,on_enumeration_warning_with_continue_false),fail)
390		),
391		Exc,
392		(exit_error_scope(Level,_,on_enumeration_warning_with_continue_exception), % We do not catch timeouts
393		(Exc=enumeration_warning(_,_,_,_,_) -> call(BackupCall) ; throw(Exc))
394		)
395		),
396		exit_error_scope_if_necessary(Level,on_enumeration_warning_with_continue_timeout) % TIMEOUT
397		).
398
399		% check if we are simply calling on_enumeration_warning with trivial true call; avoid call_cleanup, error_scope.
400		is_true_call(_:X) :- !, nonvar(X), is_true_call(X).
401		is_true_call(call(X)) :- !, is_true_call(X).
402		is_true_call(true).
403
404		catch_enumeration_warning_exceptions(Call, BackupCall) :-
405	?	catch_enumeration_warning_exceptions_and_wd_failures(Call,BackupCall,false,fail,unknown).
406		catch_enumeration_warning_exceptions(Call, BackupCall, AddAsEventError) :-
407		catch_enumeration_warning_exceptions_and_wd_failures(Call,BackupCall,AddAsEventError,fail,unknown).
408		catch_enumeration_warning_exceptions(Call, BackupCall, AddAsEventError,Source) :-
409	?	catch_enumeration_warning_exceptions_and_wd_failures(Call,BackupCall,AddAsEventError,fail,Source).
410
411		% can be used to check if an exception is an enumeration warning
412		is_enumeration_warning_exception(enumeration_warning(_Enumerating,_Type,_Range,_RestrRange,_Critical)).
413
414		% removed usage of call_cleanup; can cause huge runtime in debug_mode, cf SPRM-21383 but also e.g. for ProPlanGross.mch
415		% but simple_call_cleanup requires that C does not backtrack and CleanupCall called in case of exception
416		% does not catch timeouts, relevant for test 2355
417		% but using call_cleanup in SICStus 4.9 for PlanProGross.mch results in timeout after several minutes in setup constants
418		:- meta_predicate simple_call_cleanup(0,0).
419	?	simple_call_cleanup(C,CleanupCall) :- if(C,CleanupCall, (CleanupCall,fail)).
420
421		% AddAsEventError = true means that caught exceptions are added as event_errors in scope
422		% (this can be important if we later want to decide whether an enumeration warning occured)
423		% WDCall: this gets called when a well_definedness_error is raised by the Call
424		% assumes Call does not backtrack to use simple_call_cleanup
425		catch_enumeration_warning_exceptions_and_wd_failures(Call, BackupCall,AddAsEventError,WDCall,Source) :-
426		enter_new_error_scope(Level,catch_enumeration_warning_exceptions),
427		% print(enter(Level)),nl,
428		% difference: we do not force to throw_errors_in_scope
429		(Source = ignore(_) -> silent_enum_warnings_in_scope(Level,critical) ; true),
430	?	catch(
431		simple_call_cleanup(if(Call,true,catch_wd(Level,WDCall,Source)),
432		(%print(exit(Level)),nl,
433		exit_error_scope(Level,_,catch_enumeration_warning_exceptions))),
434		% call_cleanup can be tricky in case of success of Call: the error scope may not be exited immediately; TO DO: maybe rewrite using same style as above (using if + catch)
435		enumeration_warning(A,B,C,D,E),
436		(exit_error_scope(Level,_,catch_enumeration_warning_exceptions), % added due to simple_call_cleanup
437		(AddAsEventError=false
438		-> (Source=ignore(Src)
439		-> debug_format(19,'%%% Ignoring unbounded enumeration warning (source:~w).~n',[Src])
440		; true)
441		% inform that enum warning was not serious: there is a fall-back solution
442		; assert_event_in_error_scope_without_throw(enumeration_warning(A,B,C,D,E))),
443		BackupCall)).
444
445		catch_wd(Level,WDCall,Source) :-
446		WDCall \= fail,
447		% print(check_wd(Level,Source)),nl, portray_events_in_error_scope,nl,
448		specific_event_occurred_at_level(Level,well_definedness_error),!,
449		formatsilentmsg(user_output,'%%% well_definedness_error (source:~w).~n',[Source]),
450		call(WDCall).
451		catch_wd(_,_,_) :- fail.
452
453
454		% execute some code when enumeration warning occurs; and then throw exception again
455		observe_enumeration_warnings(Call,ObserverCallToExecute) :-
456		catch(Call, enumeration_warning(A,B,C,D,E),
457		call_cleanup(ObserverCallToExecute, throw(enumeration_warning(A,B,C,D,E)))).
458
459
460		% sets up a new error scope and forces enumeration_warnings to be thrown
461		% the exceptions are not caught !
462		call_with_enumeration_warning(Call) :-
463		enter_new_error_scope(Level,call_with_enumeration_warning),
464		throw_enumeration_warnings_in_scope(Level,_,unknown),
465		call_cleanup(
466		(Call, % the assumption is that Call will only have one solution
467		exit_error_scope(Level,_,call_with_enumeration_warning_true)),
468		exit_error_scope_if_necessary(Level,call_with_enumeration_warning_timeout) % failure, TIMEOUT or Exception
469		).
470
471
472		% a version of time_out which treats enumeration_warnings like time-outs
473		% and also checks enumeration_warnings in case of failure
474		% assumes we only look for one solution (otherwise error scope cleanup has to be changed !! )
475		time_out_with_enum_warning_one_solution(Call,TO,TimeOutRes,ClearEnumWarnings) :-
476		enter_new_error_scope(Level,time_out_with_enum_warning_one_solution),
477		call_cleanup(
478		catch(
479		time_out_check_enum_warning_for_failure(Call,TO,TimeOutRes,ClearEnumWarnings,perform_cut),
480		enumeration_warning(A,B,C,D,E),
481		% no need to clear: we leave error_scope below
482		TimeOutRes=virtual_time_out(thrown_enumeration_warning(A,B,C,D,E))),
483		exit_error_scope(Level,_,time_out_with_enum_warning_one_solution)).
484
485		% here enumeration warnings are not cleared and propagated to outer error scope
486		time_out_with_enum_warning_one_solution(Call,TO,TimeOutRes) :-
487		time_out_with_enum_warning_one_solution(Call,TO,TimeOutRes,no_clear).
488
489
490		enumeration_warning_occured_in_error_scope :-
491	?	event_occurred_in_error_scope(enumeration_warning(_,_,_,_,_)).
492
493		abort_error_occured_in_error_scope :-
494		event_occurred_in_error_scope(abort_error(_)). % is this still being generated??
495		abort_error_occured_in_error_scope :-
496		event_occurred_in_error_scope(well_definedness_error).
497
498
499		% just like above; but does not set up new error_scope (for performance) and clears enumeration warnings in case of failure and success
500		time_out_with_enum_warning_one_solution_no_new_error_scope(Call,TO,TimeOutRes) :-
501		(enumeration_warning_occured_in_error_scope
502		-> %trace,
503		format('Events in error block:~n',[]),portray_events_in_error_scope,
504		add_internal_error('Error block already has enumeration warnings',time_out_with_enum_warning_one_solution_no_new_error_scope(Call,TO,TimeOutRes))
505		; true),
506		% Note: will call safe_time_out which will not call time_out when time_out_preference_disabled / disable_time_out
507		catch(
508		time_out_check_enum_warning_for_failure(Call,TO,TimeOutRes,clear_errors,perform_cut), % clear errors so we can continue using same error scope
509		enumeration_warning(A,B,C,D,E),
510		%% (print(enum_warning),nl,TimeOutRes=time_out)). %%
511		TimeOutRes=virtual_time_out(thrown_enumeration_warning(A,B,C,D,E))).
512
513
514		% check if a result is a time_out:
515		is_time_out_result(time_out).
516		is_time_out_result(virtual_time_out(_)).
517
518		% a version which is to be used not for a single call but for backtracking
519		% generate virtual time_out at the end if enumeration warning occured
520
521		time_out_with_enum_warning_for_findall(Call,TO,TimeOutRes) :-
522		enter_new_error_scope(Level,time_out_with_enum_warning_for_findall),
523	?	time_out_with_enum_warning_for_findall2(Level,Call,TO,TimeOutRes).
524
525		time_out_with_enum_warning_for_findall2(_Level,Call,TO,TimeOutRes) :- %print(enter(_Level)),nl,
526	?	catch(
527		time_out_check_enum_warning_for_failure(Call,TO,TimeOutRes,no_clear,no_cut),
528		Exc,
529		get_virtual_time_out_from_exception(Exc,TimeOutRes)). % virtual time_out
530		time_out_with_enum_warning_for_findall2(Level,_Call,_TO,_TimeOutRes) :- % print(exit(Level)),nl,
531		clear_events_in_error_scope(Level,enumeration_warning(_,_,_,_,_)),
532		exit_error_scope(Level,_,time_out_with_enum_warning_for_findall2),fail.
533
534		% a version of time_out_with_enum_warning_for_findall where you manually have to enter_new_error_scope before
535		% and exit_error_scope afterwards; useful if you repeatedly call this predicate and want to set up the block only once
536		time_out_with_enum_warning_for_findall_in_current_error_scope(_Level,Call,TO,TimeOutRes) :- %print(enter(_Level)),nl,
537	?	catch(
538		time_out_check_enum_warning_for_failure(Call,TO,TimeOutRes,no_clear,no_cut),
539		Exc,
540		get_virtual_time_out_from_exception(Exc,TimeOutRes)). % virtual time_out
541		time_out_with_enum_warning_for_findall_in_current_error_scope(Level,_Call,_TO,_TimeOutRes) :-
542		% does not exit level
543		clear_events_in_error_scope(Level,enumeration_warning(_,_,_,_,_)),fail.
544
545		% ------------
546
547		% see if an exception corresponds to a virtual_timeout in the form of an enumeration warning
548		% also treats a CLPFD overflow as a virtual time-out in the sense that computation was aborted
549		get_virtual_time_out_from_exception(enumeration_warning(Cause,_,_,_,_),TimeOutRes) :- !,
550		get_virtual_time_out_res(Cause,TimeOutRes).
551		get_virtual_time_out_from_exception(error(_ErrMsg,ErrTerm),TimeOutRes) :-
552		is_clpfd_overflow_representation_error(ErrTerm,Cause),!,
553		clpfd_overflow_msg(Msg),
554		add_warning(clpfd_overflow,Msg),
555		TimeOutRes = virtual_time_out(Cause).
556		get_virtual_time_out_from_exception(Exc,_) :- % not detected as virtual time-out: throw again
557		throw(Exc).
558
559		get_virtual_time_out_res(kodkod_timeout,Res) :- !, Res= virtual_time_out(kodkod_timeout).
560		get_virtual_time_out_res(_,virtual_time_out(exception)).
561
562
563		is_clpfd_overflow_representation_error(representation_error(_Constraint,_,CauseMsg),CauseMsg) :-
564		is_clpfd_overflow_representation_error_msg(CauseMsg).
565		is_clpfd_overflow_representation_error(domain_error(list_to_fdset(_FDLIST,_),_,_,_List),CauseMsg) :-
566		CauseMsg = 'CLPFD integer overflow'.
567		is_clpfd_overflow_representation_error_msg('CLPFD integer overflow').
568		is_clpfd_overflow_representation_error_msg('max_clpfd_integer').
569		is_clpfd_overflow_representation_error_msg('min_clpfd_integer').
570
571		clpfd_overflow_msg(M) :- clpfd_interface:is_64_bit_system, !,
572		(get_preference(use_clpfd_solver,true)
573		-> M = 'A CLPFD integer overflow occurred.\nSet CLPFD preference to FALSE (Animation Preferences).'
574		; M = 'A CLPFD integer overflow occurred (despite CLPFD preference being FALSE).' % should normally not happen
575		).
576		clpfd_overflow_msg('A CLPFD integer overflow occurred.\nSet CLPFD preference to FALSE (Animation Preferences) or use a 64 bit version of ProB.').
577
578		% -----------------
579
580		:- use_module(tools_meta,[safe_time_out/3]).
581		% a version of time_out which upon failure checks if enumeration warnings were generated
582		time_out_check_enum_warning_for_failure(Call,TO,TimeOutRes,ClearErrors,CutAfterFirstSol) :-
583	?	safe_time_out(Call,TO,TimeOutRes), % a safe version which checks that time-out value TO is not too large
584		%call(Call), TimeOutRes=ok,
585		(TimeOutRes = time_out -> ! %, print(real_timeout),nl
586		; (ClearErrors=clear_errors -> clear_enumeration_warnings ; true),
587		(CutAfterFirstSol=perform_cut -> ! ; true)
588		%,print(sol),nl
589		).
590		time_out_check_enum_warning_for_failure(_Call,_TO,TimeOutRes,ClearErrors,_) :- % print(failure),nl,
591	?	virtual_time_out_occured_in_error_scope(TimeOutRes),
592		(ClearErrors=clear_errors -> clear_enumeration_warnings ; true).
593
594		virtual_time_out_occured_in_error_scope(TimeOutRes) :-
595	?	event_occurred_in_error_scope(enumeration_warning(A,B,C,D,critical)), % print(virtual),nl,
596		TimeOutRes = virtual_time_out(failure_enumeration_warning(A,B,C,D,critical)). % we have not investigated all possibilities; generate virtual time_out
597
598		critical_enumeration_warning_occured_in_error_scope :-
599	?	critical_enumeration_warning_occured_in_error_scope(_,_,_,_).
600		critical_enumeration_warning_occured_in_error_scope(A,B,C,D) :-
601	?	event_occurred_in_error_scope(enumeration_warning(A,B,C,D,critical)).
602
603		clear_enumeration_warnings :-
604		clear_events_in_current_error_scope(enumeration_warning(_,_,_,_,_)).
605
606		% retract events and raise real warnings
607		% Src and Msg used if these are not enumeration warnings
608		translate_events_in_current_scope_to_warnings(Src,Msg) :-
609		get_counter(cur_block_level,L),
610	?	retract(specific_event_occurred_at_level(L,Event)),
611		(translate_enumeration_warning(Event,EMsg,Span)
612		-> add_warning(enumeration_warning,EMsg,'',Span)
613		; add_warning(Src,Msg,Event)),
614		fail.
615		translate_events_in_current_scope_to_warnings(_,_).
616
617		% see also: print_enum_warning
618		translate_enumeration_warning(enumeration_warning(Enumerating,Type,Range,RestrictedRange,_Throwing), Msg,Span) :-
619		translate_enumeration_info(Enumerating,Info,Span),
620		ajoin(['Unbounded enumeration of ',Info,':',Type,', narrowing range: ',Range,' ---> ',RestrictedRange],Msg).
621		% Throwing=throwing -> print_pending_abort_info ?
622
623		translate_enumeration_info(enumerating(Info),Res,Span) :- !, translate_enumeration_info(Info,Res,Span). % TO DO: call get_trigger_info
624		translate_enumeration_info(b(identifier(Id),_,Info),Res,Span) :- !, Res=Id,Span=Info.
625		translate_enumeration_info(I,I,I).
626
627		% show all events in current error scope
628		portray_events_in_error_scope :- event_occurred_in_error_scope(E),
629		portray_event(E),fail.
630		portray_events_in_error_scope.
631
632		portray_event(enumeration_warning(Source,Type,Range,RestrictedRange,Critical)) :-
633		translate_enumeration_info(Source,Res,_Span), !,
634		format(' *** Enumeration Warning (~w): Source ~w, Type: ~w, Range reduction: ~w ---> ~w~n',
635		[Critical, Res, Type, Range, RestrictedRange]).
636		portray_event(E) :- format(' *** ~w~n',[E]).
637
638		% translate an event error to a short human readable form:
639		translate_error_event(Error,TransError) :-
640		(translate_enumeration_warning(Error,Msg,_)
641		-> TransError=Msg
642		; TransError=Error). % TODO: translate other errors
643
644		% -----------------------
645
646		:- volatile logged_error_hash/5, real_error_occurred/0, logged_error_spans/2, saved_subsidiary_span_pos/4.
647		:- dynamic logged_error_hash/5.
648		:- dynamic logged_message/4.
649		:- dynamic real_error_occurred/0, warning_occurred/0.
650		:- dynamic logged_error_spans/2.
651		:- dynamic saved_subsidiary_span_pos/4. % for Tcl/Tk
652
653
654		reset_real_error_occurred :-
655		(retract(real_error_occurred) -> true ; true),
656		(retract(warning_occurred) -> true ; true).
657
658		reset_errors :-
659		(reset_errors_but_not_scopes -> true
660		; format(user_error,'~n*** reset_errors_but_not_scopes failed!!~n',[]),
661		fail % something really bad happened
662		),
663		reset_error_limit_reached,
664		reset_error_scopes. % call if you want to start again at a fresh top-level, without error scopes
665		reset_errors_but_not_scopes :-
666		reset_real_error_occurred,
667		retractall(logged_error_hash(_,_,_,_,_)),
668		retractall(logged_message(_,_,_,_)),
669		reset_error_spans,
670		clear_error_context.
671
672		reset_error_span_if_required :-
673	?	(logged_error_hash(_,_,_,_,_) -> true
674		; retractall(logged_error_spans(_,_))).
675
676		reset_error_spans :-
677		retractall(logged_error_spans(_,_)),
678		retractall(saved_subsidiary_span_pos(_,_,_,_)).
679
680		wd_error_occured :-
681		test_error_occurred(well_definedness_error).
682
683		clear_wd_errors :-
684		clear_errors_with_source(well_definedness_error).
685		clear_errors_with_source(Source) :-
686		retractall(logged_error_spans(Source,_)),
687		retractall(logged_error_hash(_,Source,_S1,_TContext1,_Span1)),
688		retractall(logged_message(Source,_,_,_)),
689		(logged_error_hash(_,_Source2,_S2,_TContext2,_Span2) -> true
690		; reset_real_error_occurred).
691
692		print_error_span(Span) :- print_error_span(Span,error).
693		print_error_span(unknown,_) :- !.
694		print_error_span(none,_) :- !. % from Rodin
695		print_error_span([],_) :- !. % empty info list
696		print_error_span(Span,Kind) :-
697		extract_span_description(Span,PosMsg), !, % also detects info lists
698		print_error(Kind,PosMsg).
699		print_error_span(b(E,T,I),Kind) :-
700		translate_bexpr(b(E,T,I),S),!,
701		print_error(Kind,S).
702		print_error_span(span_predicate(P,_,_),Kind) :- translate_bexpr(P,S),!,
703		% can happen in Event-B when no position info can be extracted
704		print_error(Kind,S).
705		print_error_span(List,Kind) :- List = [_|_], % info list which was not recognised; probably Event-B mode
706		debug_mode(off),
707		!,
708		include(useful_info,List,UsefulList), % only show useful infos
709		(UsefulList = [] -> true
710		; print_error(Kind,UsefulList)).
711		print_error_span(Span,Kind) :- print_error(Kind,Span). % span not recognized !
712
713		useful_info(section(_)).
714		useful_info(used_ids(_)).
715
716
717		translate_bexpr(P,S) :-
718		(debug_mode(on) -> Lim=3000 ; Lim=1000),
719		translate:translate_subst_or_bexpr_with_limit(P,Lim,S).
720
721		% the same, but not using user_error and red and only printing when span recognised
722		% more detailed than translate:print_span
723		print_message_span(unknown) :- !.
724		print_message_span(Span) :-
725		extract_span_description(Span,PosMsg), !, print(PosMsg).
726		print_message_span(_). % span not recognized !
727
728		% try and extract a string (aka atom) describing the position
729		extract_span_description(Span,PosMsg) :- extract_span_description_with_opts(Span,PosMsg,[]).
730
731		extract_span_description_with_opts(span_predicate(P,_,_),PosMsg,Opts) :- !,
732		extract_span_description_with_opts(P,PosMsg,Opts).
733		extract_span_description_with_opts(b(E,_,I),PosMsg,Opts) :- !,
734		(extract_span_description_with_opts(I,PosMsg,Opts) -> true
735		; first_sub_expr(E,A) -> extract_span_description_with_opts(A,PosMsg,Opts)).
736		extract_span_description_with_opts(Span,PosMsg,Opts) :-
737	?	extract_line_col(Span,StartLine,StartCol,EndLine,EndCol),!,
738		(member(compact_pos_info,Opts) -> Compact=true ; Compact=false),
739		(empty_line_col(StartLine,StartCol,EndLine,EndCol)
740		-> POS = ['Unknown position'|POS2]
741		; Compact=true
742		-> POS = ['(Line:',StartLine,',Col:',StartCol|POS2]
743		; POS = ['Line: ',StartLine,' Column: ',StartCol,
744		' until Line: ',EndLine,' Column: ',EndCol|POS2]
745		),
746		(extract_file_name_with_opts(Span,Filename,Opts)
747		-> (Compact=false -> POS2 = [' in file: ',Filename|POS3] ; POS2 = [',File:',Filename,')'|POS3])
748		; (Compact=false -> POS2 = POS3 ; POS2 = [')'|POS3])
749		),
750	?	(extract_additional_pos_and_descr(Span,_,ContextMsg,Opts)
751		-> (member(inner_context_separator(WITHIN,_),Opts) -> true ; WITHIN = ' within '),
752		POS3 = [WITHIN,ContextMsg] ; POS3=[]),
753		ajoin(POS,PosMsg).
754		extract_span_description_with_opts(Span,PosMsg,_Opts) :-
755		extract_symbolic_span_desc(Span,Symbolic),!,
756		PosMsg=Symbolic.
757		extract_span_description_with_opts(Span,PosMsg,Opts) :-
758		% try if we have an unknown position with a known context (e.g., pos_context(unknown,call_stack(...))
759		extract_additional_pos_and_descr(Span,_,ContextMsg,Opts),!,
760		%POS = ['Unknown position within ',ContextMsg],
761		POS = ['Within ',ContextMsg],
762		ajoin(POS,PosMsg).
763		% Note: Atom Plugin is quite sensitive to above error message and capitalization
764		% (https://github.com/wysiib/language-b-eventb)
765
766		extract_symbolic_span_desc(Span,PosMsg) :-
767		extract_symbolic_label_pos(Span,Symbolic),!,
768		% TO DO: we could try and find section for Rodin
769		ajoin(['@label: ',Symbolic],PosMsg).
770
771
772		% detect if a position is empty; Line 0, Column -1 .. Line 0, Column -2 used for non available Library Definition files
773		% happens, e.g., when typing CHOOSE({1}\{1}) in REPL
774		empty_line_col(0,N1,0,N2) :- integer(N1), integer(N2), N1>N2.
775
776		assert_true(Code) :-
777		(call(Code) -> true ; add_internal_error('Assertion failed: ',Code)).
778
779		add_error_fail(Source,ErrMsg, ErrTerm) :- add_error_and_fail(Source,ErrMsg, ErrTerm).
780		add_error_and_fail(Source,ErrMsg, ErrTerm) :- add_error(Source,ErrMsg, ErrTerm),fail.
781		add_error_and_fail(Source,ErrMsg) :- add_error(Source,ErrMsg),fail.
782
783		% add_error/2, add_error/3 and add_error/4
784		add_error(Source,ErrMsg) :- add_error4(Source,ErrMsg, '',unknown).
785		add_error(Source,ErrMsg, ErrTerm) :- add_error4(Source,ErrMsg, ErrTerm,unknown).
786		add_error(Source,ErrMsg,ErrTerm,Span) :- add_error4(Source,ErrMsg,ErrTerm,Span).
787
788		add_error4(Source,ErrMsg,ErrTerm,Span) :-
789		assert_real_error_occurred(Source),
790		combine_msg_and_error_term(ErrMsg,ErrTerm,Span,S),
791		add_error_or_warning(Source,S,Span).
792
793		%:- use_module(translate, [translate_error_term/2, translate_context/2]).
794		combine_msg_and_error_term(Msg,ErrTerm,_,Res) :- ErrTerm=='', !, Res=Msg.
795		combine_msg_and_error_term(ErrMsg,ErrTerm,Span,S) :-
796		string_concatenate(ErrMsg,' ',ST),
797		safe_translate_error_term(ErrTerm,Span,RString),
798		string_concatenate(ST,RString,S).
799
800
801		:- dynamic show_error_source/0.
802		show_error_source. % True if error source and span to be printed
803		turn_show_error_source_on :- (show_error_source -> true ; assertz(show_error_source)).
804		turn_show_error_source_off :- retractall(show_error_source).
805
806		trace_if_user_wants_it :- (preferences:get_preference(trace_upon_error,true) -> safe_trace ; true).
807
808		% try Prolog's trace; if this fails (compiled code), then ask user for input.
809		safe_trace :- translate:install_b_portray_hook,
810		catch(trace, error(existence_error(_,_),_), type_to_continue).
811
812		:- dynamic do_not_interrupt_user_anymore/0.
813
814		type_to_continue :- do_not_interrupt_user_anymore,!.
815		type_to_continue :- format(user_output,'(type <RETURN> to continue, z<RETURN> to zip) ===> ',[]),
816		read_line(user_input,X),
817		(zip(X) -> assertz(do_not_interrupt_user_anymore) ; true).
818
819		zip([122|_]). %starts with z
820
821
822		print_error_source(well_definedness_error) :- !,print_error('A well-definedness error occured !').
823		print_error_source(warning(Source)) :- show_error_source,!,
824		format_error_with_nl('~n! A warning occurred (source: ~w) !',[Source]).
825		print_error_source(internal_error(Source)) :- show_error_source,!,
826		flush_output, % internal error should not happen; be sure to flush all other pending outputs so that we can see where it happened
827		format_error_with_nl('~n! An internal error occurred (source: ~w) !',[Source]).
828		print_error_source(Source) :- show_error_source,!,
829		format_error_with_nl('~n! An error occurred (source: ~w) !',[Source]).
830		print_error_source(_).
831
832		print_error_context(Kind,Context) :- ((Context = '' ; \+show_error_source) -> true ; print_error(Kind,Context)).
833
834		print_error(message,Term) :- !, print_message_on_stream(user_output,[blue],Term).
835		print_error(_,Term) :- print_error(Term).
836
837		safe_translate_error_term(ErrTerm,Span,RString) :-
838		temporary_set_preference(expand_avl_upto,5,CHNG),
839		translate:translate_error_term(ErrTerm,Span,RString),
840		reset_temporary_preference(expand_avl_upto,CHNG).
841
842		safe_translate_context(Result) :-
843		% avoid infinite loop when error occurs inside translate_context
844		current_context(Context),
845		!,
846		set_error_context(translate_context),
847		temporary_set_preference(expand_avl_upto,4,CHNG),
848		(translate:translate_context(Context,TContext)
849		-> true ; TContext=Context),
850		reset_temporary_preference(expand_avl_upto,CHNG),
851		restore_error_context(Context),
852		Result=TContext.
853		safe_translate_context(''). % no context
854
855		is_optional_error_or_warning(warning(Src)) :- !, optional_error_or_warning(Src).
856		is_optional_error_or_warning(Src) :- optional_error_or_warning(Src).
857
858		add_error_or_warning(Source,ErrMsg,Span) :-
859		safe_translate_context(Context),
860		reset_error_span_if_required,
861		simplify_span(Span,SSpan), % for better hashing, assertz, retract
862		assertz_logged_error_if_new(Source,ErrMsg,Context,SSpan,New),
863		log_error_or_msg(Source,ErrMsg,SSpan),
864		(New=false -> true
865		; is_optional_error_or_warning(Source) ->
866		(extract_span_description(SSpan,PosMsg) -> true ; PosMsg=''),
867		formatsilentmsg(user_output,'% Optional error ~w occured: ~w ~w~n',[Source,ErrMsg,PosMsg]),
868		register_error_span(Source,SSpan,_)
869		; register_error_span(Source,SSpan,NewSrcSpan),
870		(NewSrcSpan=false,
871		error_limit_reached,
872		Source \= internal_error(_) % always show internal errors
873		-> true % this is not a new Source,SSpan combination and we have already several errors;
874		; print_error_source(Source),
875		print_error(ErrMsg),
876		print_error_context(error,Context),
877		print_error_span(SSpan)
878		),
879		trace_if_user_wants_it
880		).
881
882		% optionally log errors in to a ndsjon logfile
883		log_error_or_msg(Source,ErrMsg,Span) :- get_preference(error_log_file,LogFile),
884		LogFile \= '',
885		decompose_error_source(Source,Type,Src),
886		!,
887		ndjson_log(Type,Src,ErrMsg,Span,LogFile).
888		log_error_or_msg(_,_,_).
889
890		% log error, warning or message to NDJSON log file
891		% Type is warning, error, info
892		:- use_module(tools_io,[intelligent_open/4]).
893		ndjson_log(Type,Src,ErrMsg,Span,LogFile) :-
894		force_extract_position_from_span(Span,Filename,StartLine,StartCol,EndLine,EndCol),
895		catch(intelligent_open(LogFile,append,S,[encoding(utf8)]), E,
896		(format(user_error,'~n*** Cannot open error log file: ~w~n*** Exception: ~w~n',[LogFile,E]),fail)),
897		!,
898		ndjson_write(S,Type,ErrMsg,Src,Filename,StartLine,StartCol,EndLine,EndCol),
899		(extract_additional_pos_and_descr(Span,SubPos,_Desc,[]),
900		extract_position_from_span(SubPos,Filename2,StartLine2,StartCol2,EndLine2,EndCol2),
901		ndjson_write(S,Type,ErrMsg,Src,Filename2,StartLine2,StartCol2,EndLine2,EndCol2),
902		fail
903		;
904		true
905		),
906		close(S).
907		ndjson_log(_,_,_,_,_).
908
909		% assign position to main file if we cannot extract the precise position
910		force_extract_position_from_span(Span,Filename,StartLine,StartCol,EndLine,EndCol) :-
911		extract_position_from_span(Span,Filename,StartLine,StartCol,EndLine,EndCol),!.
912		force_extract_position_from_span(_Span,Filename,StartLine,StartCol,EndLine,EndCol) :-
913		bmachine:b_get_main_filenumber(MainFN),
914		get_filename(MainFN,Filename),!,
915		% generate a virtual position, so that global errors without position are shown in Atom, VSCode,...
916		StartLine=1,StartCol=1,EndLine=1,EndCol=1.
917		force_extract_position_from_span(_Span,Filename,StartLine,StartCol,EndLine,EndCol) :-
918		specfile:currently_opened_file_status(Filename,_),
919		StartLine='-1',StartCol='-1',EndLine='-1',EndCol='-1'.
920
921		%ndjson format http://ndjson.org
922		% one JSON term per line
923		:- use_module(extrasrc(json_parser),[json_write_stream/2]).
924		ndjson_write(S,Type,ErrMsg,Src,Filename,StartLine,StartCol,EndLine,EndCol) :-
925		version:version_str(Version),
926		Term = json([type=string(Type), % Type is warning, error, info
927		message=string(ErrMsg),
928		reason=string(Src),
929		file=string(Filename),
930		start=json([line=number(StartLine),col=number(StartCol)]),
931		end=json([line=number(EndLine),col=number(EndCol)]),
932		version=string(Version)
933		]),
934		json_write_stream(S,Term), nl(S).
935
936		decompose_error_source(warning(Source),warning,Res) :- !, Res=Source.
937		decompose_error_source(internal_error(Source),internal_error,Res) :- !, Res=Source.
938		decompose_error_source(message(Source),information,Res) :- !, Res=Source. % mainly for NDJSON
939		decompose_error_source(Msg,error,Msg).
940
941
942		% the total number of errors since start; no way to reset this; useful for validation reports
943		% TO DO: maybe use counter extension; but tricky to get dependency and initialisation right
944		get_total_number_of_errors(X) :-
945		(bb_get(total_number_of_errors,R) -> X=R
946		; X=0).
947
948		inc_total_number_of_errors :-
949		(bb_get(total_number_of_errors,R)
950		-> R1 is R+1, bb_put(total_number_of_errors,R1)
951		; bb_put(total_number_of_errors,1)).
952
953
954		total_number_of_errors_at_last_reset(Res) :-
955		(bb_get(total_number_of_errors_at_last_reset,R) -> Res=R ; Res=0).
956
957		reset_error_limit_reached :-
958		bb_put(error_limit_reached_printed,false),
959		get_total_number_of_errors(T),
960		bb_put(total_number_of_errors_at_last_reset,T).
961
962		error_limit_reached :- bb_get(error_limit_reached_printed,true),!.
963		error_limit_reached :- get_total_number_of_errors(Nr), Nr >= 100,
964		total_number_of_errors_at_last_reset(Last), Delta is Nr-Last, Delta >= 100,
965		format_error_with_nl('Error limit reached (total: ~w, delta: ~w); only printing new error source and locations!',[Nr,Delta]),
966		bb_put(error_limit_reached_printed,true).
967
968		assert_warning_occured :-
969		(preferences:get_preference(strict_raise_warnings,true)
970		-> assert_real_error_occurred(warning)
971		; warning_occurred -> true
972		; assertz(warning_occurred)).
973		assert_real_error_occurred(Source) :-
974		(real_error_occurred -> true ; assertz(real_error_occurred)),
975		inc_total_number_of_errors,
976		assert_real_error_in_current_block(Source).
977
978		:- use_module(hashing,[term_depth_hash/3]).
979		assertz_logged_error_if_new(Source,S,TContext,Span,New) :-
980		% limit depth mainly for TContext/Span; avoiding generating many similar error messages with same msg
981		% however, for WD errors often the msg varies (e.g. argument for function application); so this will not prevent a lot of errors
982		term_depth_hash(logged_error_hash(Source,S,TContext,Span),4,Hash),
983		(logged_error_hash(Hash,Source,S,TContext,Span)
984		-> debug_println(repeated_error(Hash)),New=false
985		; %print(new(Hash,Source,S,TContext,Span)),nl,
986		assertz(logged_error_hash(Hash,Source,S,TContext,Span)),
987		New=true).
988
989	?	logged_error(Source,S,TContext,Span) :- logged_error_hash(_Hash,Source,S,TContext,Span).
990
991		add_warning(Source,ErrMsg, ErrTerm) :-
992		add_warning(Source,ErrMsg, ErrTerm,unknown).
993		add_warning(Source,ErrMsg, ErrTerm,Span) :-
994		safe_translate_error_term(ErrTerm,Span,RString),
995		string_concatenate(ErrMsg,RString,S),
996		assert_warning_occured,
997		add_error_or_warning(warning(Source),S,Span).
998		add_warning(Source,Message) :-
999		assert_warning_occured,
1000		add_error_or_warning(warning(Source),Message,unknown).
1001
1002		% MESSAGES
1003
1004		% add message in debug mode
1005		add_debug_message(Source,ErrMsg, ErrTerm) :-
1006		add_debug_message(Source,ErrMsg, ErrTerm,unknown).
1007		add_debug_message(Source,ErrMsg, ErrTerm, Span) :-
1008		debug_mode(on),!,
1009		add_message(Source,ErrMsg, ErrTerm, Span).
1010		add_debug_message(_,_,_,_).
1011
1012
1013		% a predicate to flexibly call add_error, add_warning or add_message
1014		add_msg_warn_or_err(debug_message,Src,Msg,Term,Pos) :- !, add_debug_message(Src,Msg,Term,Pos).
1015		add_msg_warn_or_err(message,Src,Msg,Term,Pos) :- !, add_message(Src,Msg,Term,Pos).
1016		add_msg_warn_or_err(warning,Src,Msg,Term,Pos) :- !, add_warning(Src,Msg,Term,Pos).
1017		add_msg_warn_or_err(_Kind,Src,Msg,Term,Pos) :- add_error(Src,Msg,Term,Pos).
1018
1019		add_message(Source,ErrMsg, ErrTerm) :- /* same as add_error but does not add err msg */
1020		add_message(Source,ErrMsg, ErrTerm,unknown).
1021
1022		add_message(_,_, _,unknown) :- error_manager_silent_mode(on),!.
1023		add_message(Source,ErrMsg, ErrTerm,Span) :- /* same as add_error but does not add err msg */
1024		safe_translate_error_term(ErrTerm,Span,RString),
1025		string_concatenate(ErrMsg,RString,S),
1026		add_message_direct(Source, S),
1027		safe_translate_context(Context),
1028		print_error_context(message,Context),
1029		print_error_span(Span,message),
1030		log_error_or_msg(message(Source),S,Span),
1031		assertz(logged_message(Source,S,Context,Span)).
1032
1033		add_message(_,_) :- error_manager_silent_mode(on),!.
1034		add_message(Source,ErrMsg) :- add_message_direct(Source,ErrMsg).
1035
1036		add_message_direct(Source,ErrMsg) :-
1037		(show_error_source -> format_with_colour(user_output,[light_gray],'! Message (source: ~w):~n',[Source]) ; true),
1038		print_error(message,ErrMsg).
1039
1040
1041		% adds a list of errors with position information
1042		% [error(Msg,Pos)] or [warning(Msg,Pos)...]
1043		no_real_perror_occurred([]).
1044		no_real_perror_occurred([warning(_,_)|T]) :- no_real_perror_occurred(T).
1045
1046		add_all_perrors(Errors) :- add_all_perrors(Errors,[],bmachine).
1047		add_all_perrors(Errors,Files) :- add_all_perrors(Errors,Files,bmachine).
1048		add_all_perrors(Errors,Files,Context) :- add_all_perrors(Errors,Files,Context,0,100,error).
1049		add_all_perrors(Errors,Files,Context,WarnOrErr) :-
1050		add_all_perrors(Errors,Files,Context,0,100,WarnOrErr).
1051
1052		add_all_perrors([],_,_,_,_,_).
1053		add_all_perrors([H|Rest],_Filenames,ContextOfError,NrOfErrors,MaxErrors,WarnOrErr) :-
1054		NrOfErrors >= MaxErrors,!,
1055		length([H|Rest],Len),
1056		add_msg_warn_or_err(WarnOrErr,ContextOfError,
1057		'Reached maximium number of errors; number of errors not reported: ',
1058		Len,unknown).
1059		add_all_perrors([Error|Rest],Filenames,ContextOfError,NrOfErrors,MaxErrors,WarnOrErr) :-
1060		get_perror(Error,ParseErrOrWarn,Msg,Pos),
1061		extract_perror_pos(Pos,Filenames,NewPos),
1062		(ParseErrOrWarn == warning -> add_warning(ContextOfError,Msg,'',NewPos)
1063		; ParseErrOrWarn = internal_error -> add_internal_error(ContextOfError,Msg,'',NewPos)
1064		; add_msg_warn_or_err(WarnOrErr,ContextOfError,Msg,'',NewPos)),
1065		N1 is NrOfErrors+1,
1066		add_all_perrors(Rest,Filenames,ContextOfError,N1,MaxErrors,WarnOrErr).
1067
1068		extract_perror_pos(Pos,Filenames,ResPOS) :-
1069		get_position_row_cols(Pos,Srow,Scol,Erow,Ecol),
1070		get_position_filenumber(Pos,Filenumber),!,
1071		( get_filename(Filenumber,Filenames,Filename)
1072		%Ecol1 is Ecol+1,
1073		-> ResPOS = src_span(Filenumber,Filename,Srow,Scol,Erow,Ecol,[],[])
1074		% ; Filenumber = -1, Filenames=[FN] -> % just a single filename, e.g., in VisB parsing
1075		% % TODO: we need to adjust line and column numbers using a reference position
1076		% POS = src_position_with_filename_and_ec(Srow,Scol,Erow,Ecol,FN)
1077		; ResPOS = src_span(Srow,Scol,Erow,Ecol,[],[])
1078		).
1079		extract_perror_pos(pos(Srow,Scol,Filename),Files,POS) :- !, % deprecated ?
1080		adapt_null_file_name(Filename,Files,Filename2),
1081		S1 is Scol+0, % zero width span
1082		POS = src_position_with_filename_and_ec(Srow,Scol,Srow,S1,Filename2).
1083		extract_perror_pos(pos(Srow,Scol,Erow,Ecol,Filename),Files,POS) :- !,
1084		adapt_null_file_name(Filename,Files,Filename2),
1085		%Ecol1 is Ecol+1,
1086		POS = src_position_with_filename_and_ec(Srow,Scol,Erow,Ecol,Filename2).
1087		extract_perror_pos(pos(Srow,Scol),_,POS) :- !, print(deprecated_pos(Srow,Scol)),nl,
1088		POS = src_position(Srow,Scol,none,1).
1089		extract_perror_pos(Pos,_,Pos).
1090
1091		% adapt filename
1092		adapt_null_file_name(null,[File],Res) :-
1093		!, % the error is not associated to a given file, but we have a file list with just a single file;
1094		% occurs e.g. when parsing VisB JSON files
1095		Res=File.
1096		adapt_null_file_name(F,_,F).
1097
1098		get_perror(error(Msg,Pos),error,Msg,Pos) :- !.
1099		get_perror(internal_error(Msg,Pos),internal_error,Msg,Pos) :- !.
1100		get_perror(warning(Msg,Pos),warning,Msg,Pos) :- !.
1101		get_perror(M,_,M,unknown) :- format(user_error,'*** unknown perror: ~w~n',[M]).
1102
1103		% version without list of filenames
1104		get_filename(Filenumber,Filename) :-
1105		bmachine:b_get_all_used_filenames(FN),
1106		get_filename(Filenumber,FN,Filename).
1107
1108		get_filename(Filenumber,Filenames,Filename) :-
1109		number(Filenumber),!,
1110		nth1(Filenumber,Filenames,Filename).
1111		get_filename(N,F,R) :-
1112		add_internal_error('Cannot get filename: ',get_filename(N,F,R)),
1113		N=1,F=[R|_]. % return first file if possible
1114
1115		% check if error/warning occured and retract matching error/warning
1116		get_error_with_span(Source,ErrMsg,Span) :-
1117	?	retract(logged_error_hash(_Hash,Source,ErrMsg,_Context,Span)).
1118		get_error(Source,ErrMsg) :-
1119	?	retract(logged_error_hash(_,Source,ErrMsg,_,_)).
1120		get_warning(Source,ErrMsg) :-
1121		retract(logged_error_hash(_,warning(Source),ErrMsg,_,_)).
1122
1123		% now the same without actually retracting the error/warning:
1124	?	check_error_occured(Source,ErrMsg) :- logged_error(Source,ErrMsg,_,_).
1125		check_warning_occured(Source,ErrMsg) :- logged_error(warning(Source),ErrMsg,_,_).
1126
1127		get_next_error_or_warning(Msg) :- get_error_or_message(_Src,Type,Msg),
1128		Type \= message. % retract message, but do not return it
1129		get_error_or_message(Source,Type,Msg) :-
1130		retract_logged_error_or_message(Source,Type,ErrMsg,Context,Span),
1131		(extract_line_col(Span,StartLine,StartCol,EndLine,EndCol)
1132		-> POS = ['\n ### Line: ',StartLine,', Column: ',StartCol|POS1],
1133		((StartLine,StartCol) \= (EndLine,EndCol)
1134		-> (StartLine=EndLine -> POS1 = [' until ',EndCol|POS2]
1135		; POS1 = ['\n ### until Line: ',EndLine,', Column: ',EndCol|POS2]
1136		)
1137		; POS1 = POS2
1138		),
1139		(extract_additional_description(Span,CMsg)
1140		-> POS2 = ['\n ### within: ',CMsg,'\n\n']
1141		; POS2 = ['\n\n']
1142		),
1143		(extract_relative_file_name(Span,Filename)
1144		-> PosMsg = ['\n ### File: ',Filename | POS]
1145		; PosMsg = POS
1146		),
1147		tools:ajoin(PosMsg,EndStr)
1148		; extract_symbolic_span_desc(Span,CMsg)
1149		-> tools:ajoin(['\n ### ',CMsg,'\n\n'],EndStr)
1150		; EndStr = '\n\n'
1151		),
1152		(empty_error_context(Context)
1153		-> string_concatenate(ErrMsg,EndStr,S0)
1154		; safe_translate_error_term(Context,Span,CString),
1155		string_concatenate(CString,EndStr,CString2),
1156		string_concatenate('\n',CString2,CString3), % prefix used to be ': Context ='
1157		string_concatenate(ErrMsg,CString3,S0)
1158		),
1159		(debug_mode(off) -> Msg = S0
1160		; decompose_error_source(Source,_,SrcAtom),
1161		string_concatenate(SrcAtom,': ',S1),
1162		string_concatenate(S1,S0,Msg)
1163		).
1164
1165		empty_error_context('').
1166		empty_error_context('???').
1167
1168
1169		% retract an error
1170		retract_logged_error_or_message(Source,Type,ErrMsg,Context,Span) :- Type \== message,
1171		retract(logged_error_hash(_Hash,Source,ErrMsg,Context,Span)),
1172		(Source = warning(_) -> Type=warning
1173		; Source = internal_error(_) -> Type=internal_error
1174		; Type=error).
1175		retract_logged_error_or_message(message(Source),message,ErrMsg,Context,Span) :-
1176		retract(logged_message(Source,ErrMsg,Context,Span)).
1177
1178
1179		get_error_with_span_info(FullErrMsg,Type,ErrLocations) :-
1180		retract_logged_error_or_message(_Source,Type,ErrMsg,Context,Span),
1181		(empty_error_context(Context) -> FullErrMsg=ErrMsg
1182		; safe_translate_error_term(Context,Span,CString),
1183		ajoin([ErrMsg,'\n',CString],FullErrMsg)
1184		),
1185		findall( error_span(Filename,StartLine,StartCol,EndLine,EndCol),
1186		extract_position_from_span(Span,Filename,StartLine,StartCol,EndLine,EndCol),
1187		ErrLocations).
1188		get_error_with_span_and_context(ErrMsg,Type,ErrLocations,GlobalContext,SpanContext) :-
1189		% Global context: top-level info about what ProB was doing
1190		% Local SpanContext: definition call hierarchy or call stack
1191		retract_logged_error_or_message(_Source,Type,ErrMsg,GlobalContext,Span),
1192		(extract_additional_description(Span,SpanContext) -> true ; SpanContext=''),
1193		findall( error_span(Filename,StartLine,StartCol,EndLine,EndCol),
1194		extract_position_from_span(Span,Filename,StartLine,StartCol,EndLine,EndCol),
1195		ErrLocations).
1196
1197		extract_position_from_span(Span,Filename,StartLine,StartCol,EndLine,EndCol) :-
1198		extract_line_col(Span,StartLine,StartCol,EndLine,EndCol),
1199		(extract_file_name(Span,FName) -> Filename=FName ; Filename='').
1200
1201		% Tcl/Tk interface of SICStus cannot deal with certain strange Unicode symbols
1202		% see prob_examples/public_examples/B/Puzzles/LogicQuestion.mch where code 55349 appears
1203		tk_escape(Atom,EAtom) :- atom(Atom),!,
1204		atom_codes(Atom,C),
1205		maplist(tk_escape_code,C,EC),
1206		atom_codes(EAtom,EC).
1207		tk_escape(list(L),list(EL)) :- !, maplist(tk_escape,L,EL).
1208		tk_escape(X,X).
1209
1210		tk_escape_code(StrangeUnicode,Res) :-
1211		StrangeUnicode > 55000,!, % not sure what the limit should be here
1212		Res = 9633. % white box
1213		tk_escape_code(Code,Code).
1214
1215		tcltk_get_all_errors(Limit,list(ERes),NrErrorsShown,NrErrors) :-
1216		get_all_errors(All),
1217		length(All,NrErrors),
1218		(NrErrors =< Limit -> Res = All, NrErrorsShown = NrErrors
1219		; prefix_length(All,Res,Limit), % truncate
1220		NrErrorsShown = Limit
1221		),
1222		tk_escape(list(Res),list(ERes)).
1223
1224
1225		get_all_errors(All) :-
1226		findall(Err,get_next_error_or_warning(Err),All),
1227		All \= [],
1228		clear_error_context.
1229
1230		get_all_errors_and_clear(All) :-
1231		findall(Err,get_next_error_or_warning(Err),All),
1232		reset_errors_but_not_scopes,
1233		All \= [].
1234		get_all_errors_and_reset(All) :-
1235		findall(Err,get_next_error_or_warning(Err),All),
1236		reset_errors, % fresh top-level
1237		All \= [].
1238		get_all_errors_with_span_info_and_reset(All) :-
1239		findall(error(ErrMsg,ErrType,ErrLocations),
1240		get_error_with_span_info(ErrMsg,ErrType,ErrLocations),All),
1241		reset_errors.
1242		get_all_errors_with_span_and_context_and_reset(All) :-
1243		findall(error(ErrMsg,ErrType,ErrLocations,GlobalContext,SpanContext),
1244		get_error_with_span_and_context(ErrMsg,ErrType,ErrLocations,GlobalContext,SpanContext),All),
1245		reset_errors.
1246
1247
1248		error_or_warning_occured :- logged_error(_Source,_,_,_),!.
1249	?	test_error_occurred(Source) :- logged_error(Source,_,_,_),real_error_occurred,!.
1250
1251		%:- use_module(library(lists),[length/2]). length is builtin
1252
1253		count_errors_occurred(Source,NrOfErrors) :-
1254		findall(1,logged_error(Source,_,_,_),Ls),
1255		length(Ls,NrOfErrors).
1256
1257		display_error_statistics :- findall(Source,logged_error(Source,_,_,_),L),
1258		count_occurences(L,Occ),
1259		format('Error manager summary: ~w~n',[Occ]).
1260
1261
1262
1263
1264		% ERROR CONTEXTS
1265		% --------------
1266
1267		/* add context information; will be added to any error messages */
1268		% Note: Each Prolog module maintains its own blackboard for bb_get/bb_put
1269		set_error_context(Ctx) :- bb_put(error_manager_context,Ctx).
1270
1271		clear_error_context :- (bb_delete(error_manager_context,_) -> true ; true).
1272		% retractall with dynamic predicate seems to slow down
1273
1274		current_context(C) :- bb_get(error_manager_context,C).
1275
1276		get_error_context(C) :- (current_context(C) -> true ; C='???').
1277		print_error_context :- (safe_translate_context(R), R\='' -> print_error(error,R) ; true).
1278
1279		% restore an error context obtained by get_error_context
1280		restore_error_context('???') :- !, clear_error_context.
1281		restore_error_context(C) :- set_error_context(C).
1282
1283
1284		% -----------------
1285
1286		get_error_span(Source,Span) :-
1287		retract(logged_error_spans(Source,Span)).
1288
1289		% a way for external modules to register error locations, e.g., for display by Tcl/Tk HighlightSyntaxErrors
1290		register_error_span(Source,Span) :- register_error_span(Source,Span,_).
1291		register_error_span(_,unknown,New) :- !,New=false.
1292		register_error_span(Source,Span,New) :- logged_error_spans(Source,Span),!,New=false.
1293		register_error_span(Source,Span,New) :- assertz(logged_error_spans(Source,Span)),New=true.
1294
1295		get_error_span_linecol(Line,Col,EndLine,EndCol) :- get_error_span_linecol(_Source,Line,Col,EndLine,EndCol).
1296		get_error_span_linecol(Source,Line,Col,EndLine,EndCol) :-
1297		get_error_span(Source,Span), % looks at logged_error_spans and retracts
1298		extract_line_col(Span,Line,Col,EndLine,EndCol).
1299
1300		% gets repeatedly called from Tcl/Tk to get all error locations
1301		tk_get_error_span_linecol_for_main_file(Line,Col,EndLine,EndCol) :-
1302		retract(saved_subsidiary_span_pos(Line,Col,EndLine,EndCol)).
1303		tk_get_error_span_linecol_for_main_file(Line,Col,EndLine,EndCol) :-
1304		get_error_span(_Source,Span), % looks at logged_error_spans and retracts even if not in main file !
1305		(extract_primary_line_col_for_main_file(Span,Line,Col,EndLine,EndCol)
1306		-> (extract_additional_pos_and_descr(Span,SubPos,_,[]),
1307		extract_line_col_for_main_file(SubPos,SLine,SCol,SEndLine,SEndCol),
1308		assertz(saved_subsidiary_span_pos(SLine,SCol,SEndLine,SEndCol)), % store for later lookup
1309		fail
1310		; true)
1311		; % try finding subsidiary position which is in main file:
1312		extract_additional_pos_and_descr(Span,SubPos,_,[]),
1313		extract_line_col_for_main_file(SubPos,Line,Col,EndLine,EndCol)
1314		).
1315
1316
1317		% just like get_error_span_linecol but does not retract and gets Filename
1318		check_error_span_file_linecol(Source, FullFilename,Line,Col,EndLine,EndCol) :-
1319	?	logged_error_spans(Source,Span),
1320		(extract_file_line_col(Span,FullFilename,Line,Col,EndLine,EndCol)
1321		;
1322	?	extract_additional_pos_and_descr(Span,SubPos,_,[]),
1323		extract_file_line_col(SubPos,FullFilename,Line,Col,EndLine,EndCol)).
1324
1325		extract_file_line_col(Span,FullFilename,Line,Col,EndLine,EndCol) :-
1326		(extract_file_number_and_name(Span,_,FullFilename)
1327		-> true
1328		; FullFilename = unknown), % e.g. something like src_span/6; should we return unknown('?')
1329	?	extract_line_col(Span,Line,Col,EndLine,EndCol).
1330
1331		% try and extract symbolic (Rodin label) information
1332		extract_symbolic_label_pos(span_predicate(P,_,_),PosMsg) :- !,
1333		extract_symbolic_label_pos(P,PosMsg).
1334		extract_symbolic_label_pos(b(E,_,I),PosMsg) :- !,
1335		(extract_symbolic_label_pos(I,PosMsg) -> true
1336		; first_sub_expr(E,A) -> extract_symbolic_label_pos(A,PosMsg)).
1337		extract_symbolic_label_pos([],_) :- !,fail.
1338		extract_symbolic_label_pos([H|T],SymbolicPos) :- !,
1339		posinfo_member(N,[H|T]),
1340		extract_symbolic_label_pos(N,SymbolicPos),!.
1341		extract_symbolic_label_pos(rodinpos(Label,_),Label). % see also get_texpr_labels in bsyntaxtree
1342		extract_symbolic_label_pos(rodinpos(Model,Name,_),Label) :- ajoin([Model,':',Name],Label).
1343		extract_symbolic_label_pos(rodin_derived_context_pos(Model,Context,LabelName),Label) :-
1344		ajoin([Model,'.',Context,':',LabelName],Label).
1345		extract_symbolic_label_pos(label(Label),Label).
1346
1347		% just extract label, without model
1348		extract_symbolic_label(span_predicate(P,_,_),PosMsg) :- !,
1349		extract_symbolic_label(P,PosMsg).
1350		extract_symbolic_label(b(E,_,I),PosMsg) :- !,
1351		(extract_symbolic_label(I,PosMsg) -> true
1352		; first_sub_expr(E,A) -> extract_symbolic_label(A,PosMsg)).
1353		extract_symbolic_label([H|T],SymbolicPos) :- !,
1354		posinfo_member(N,[H|T]),
1355		extract_symbolic_label(N,SymbolicPos),!.
1356		extract_symbolic_label(rodinpos(Label,_),Label) :- Label \= []. % see also get_texpr_labels in bsyntaxtree
1357		extract_symbolic_label(rodinpos(_Model,Label,_),Label) :- Label \= [].
1358		extract_symbolic_label(rodin_derived_context_pos(_Model,_Context,Label),Label) :- Label \= [].
1359		extract_symbolic_label(label(Label),Label) :- Label \= [].
1360
1361		% quickly try and simplify a span, e.g., before asserting it in a fact (as it may become big)
1362		simplify_span(b(E,_,Infos),Res) :- !,
1363	?	(definite_posinfo_member(N,Infos) -> Res=N
1364		; first_sub_expr(E,A) -> simplify_span(A,Res)
1365		; Res=unknown).
1366		simplify_span(Infos,Res) :- Infos = [_|_],!,
1367	?	(definite_posinfo_member(N,Infos) -> Res=N ; Res=unknown).
1368		simplify_span(span_predicate(P,_,_),Res) :- !, simplify_span(P,Res).
1369		simplify_span(S,S).
1370
1371		% choose first sub-expression in case top-expression has no position info (it would be better if extract_info/3 in bsyntaxtree merges position info)
1372		first_sub_expr(negation(A,_),A).
1373		first_sub_expr(conjunct(A,_),A).
1374		first_sub_expr(disjunct(A,_),A).
1375		first_sub_expr(implication(A,_),A).
1376		first_sub_expr(equivalence(A,_),A).
1377		first_sub_expr(exists([A|_],_),A).
1378		first_sub_expr(forall([A|_],_),A).
1379		first_sub_expr(let_predicate([A|_],_,_),A).
1380		first_sub_expr(let_expression([A|_],_,_),A).
1381		first_sub_expr(let_expression_global([A|_],_,_),A).
1382		first_sub_expr(sequence([A|_]),A).
1383		first_sub_expr(parallel([A|_]),A).
1384		first_sub_expr(assign([A|_],_),A).
1385		first_sub_expr(var([A|_],_),A).
1386		first_sub_expr(equal(A,_),A).
1387		first_sub_expr(not_equal(A,_),A).
1388		first_sub_expr(function(A,_),A).
1389		first_sub_expr(less(A,_),A).
1390		first_sub_expr(less_equal(A,_),A).
1391		% TO DO: use bsyntaxtree:syntaxtraversion
1392
1393		:- use_module(tools_positions,[get_position_filenumber/2, get_position_row_cols/5]).
1394
1395		% extract_line_col(S,_,_,_,_) :- print(extract(S)),nl,fail.
1396		extract_line_col(Var,_,_,_,_) :- var(Var),!, write(variable_span(Var)),nl,
1397		fail.
1398		extract_line_col([],_,_,_,_) :- !,fail.
1399		extract_line_col([H|T],Srow,Scol,Erow,Ecol) :- !,
1400		posinfo_member(N,[H|T]),
1401		extract_line_col(N,Srow,Scol,Erow,Ecol),!.
1402		extract_line_col(closure(_,_,B),Srow,Scol,Erow,Ecol) :- !,
1403		extract_line_col(B,Srow,Scol,Erow,Ecol).
1404		extract_line_col(b(E,_,Infos),Srow,Scol,Erow,Ecol) :- !,
1405		(extract_line_col(Infos,Srow,Scol,Erow,Ecol) -> true
1406		; first_sub_expr(E,A) -> extract_line_col(A,Srow,Scol,Erow,Ecol)).
1407		extract_line_col(span_predicate(P,_,_),Srow,Scol,Erow,Ecol) :- !,
1408		extract_line_col(P,Srow,Scol,Erow,Ecol).
1409		extract_line_col(PosTerm,Srow,S1,Erow,E1) :-
1410		get_position_row_cols(PosTerm,Srow,Scol,Erow,Ecol),
1411		number(Srow),
1412		% _Filenumber is an index into list provided by b_get_all_used_filenames
1413		number(Scol), number(Erow), number(Ecol),
1414		!,
1415		(Scol>0 -> S1 is Scol-1 ; S1 = Scol), % the BParser starts column numbering at 1
1416		(Ecol>0 -> E1 is Ecol-1 ; E1 = Ecol).
1417		%E1=Ecol. %Somehow the Ecol info is ok for Tcl
1418		extract_line_col(unknown,_,_,_,_) :- !,fail.
1419		extract_line_col(pos_context(A,_,_),StartLine,StartCol,EndLine,EndCol) :- !,
1420		extract_line_col(A,StartLine,StartCol,EndLine,EndCol).
1421		extract_line_col(src_span(_Filenr,_Filename,StartLine,SC,EndLine,EC,Offset,LenBytes),StartLine,StartCol,EndLine,EndCol)
1422		:- !,
1423		extract_line_col(src_span(StartLine,SC,EndLine,EC,Offset,LenBytes),StartLine,StartCol,EndLine,EndCol).
1424		extract_line_col(src_span(SL,SC,EL,EC,_Off,_LenBytes),StartLine,StartCol,EndLine,EndCol) :- !,
1425		StartLine=SL, StartCol is SC-1,
1426		EndLine = EL, EndCol is EC-1.
1427		%:- !, StartCol is SC-1, EndCol is StartCol+LenBytes, EndLine = StartLine. %% fix because new library generates erroneous EndLine/EndCol info
1428		% EndCol is EC-1.
1429	?	extract_line_col(span_info(_Info,Span),SL,SC,EL,EC) :- !, extract_line_col(Span,SL,SC,EL,EC).
1430		extract_line_col(src_span_operator(SP1,SP2),SL,SC,EL,EC) :- !,
1431		(extract_line_col(SP1,SL,SC,EL,EC) ; extract_line_col(SP2,SL,SC,EL,EC)).
1432		extract_line_col(multi_span(SL,SC,EL,EC,_Off,_Len,TAIL),StartLine,StartCol,EndLine,EndCol) :- !,
1433		% TO DO: replace by multi_span/2
1434		( StartLine = SL, StartCol is SC-1,
1435		EndLine = EL, EndCol is EC-1
1436		; extract_line_col(TAIL,StartLine,StartCol,EndLine,EndCol)).
1437		%extract_line_col(multi_span(A,B),StartLine,StartCol,EndLine,EndCol) :- !,
1438		% (extract_line_col(A,StartLine,StartCol,EndLine,EndCol) ;
1439		% extract_line_col(B,StartLine,StartCol,EndLine,EndCol)).
1440		extract_line_col(src_position(StartLine,SC,_Off,LenBytes),StartLine,StartCol,EndLine,EndCol) :- !,
1441		StartCol is SC-1, EndCol is StartCol+LenBytes, EndLine is StartLine.
1442		extract_line_col(src_position_with_filename(StartLine,SC,LenBytes,_Filename),StartLine,StartCol,EndLine,EndCol) :-
1443		!,
1444		StartCol is SC-1, EndCol is StartCol+LenBytes, EndLine is StartLine.
1445		extract_line_col(src_position_with_filename_and_ec(SL,SC,EL,EC,_Fname),StartLine,StartCol,EndLine,EndCol) :-
1446		!,
1447		StartLine=SL,StartCol is SC-1,EndLine = EL, EndCol is EC-1.
1448		extract_line_col(lineCol(StartLine,StartCol),StartLine,StartCol,EndLine,EndCol) :- !,
1449		EndLine=StartLine, EndCol=StartCol.
1450		extract_line_col(span_context(Span,_),StartLine,StartCol,EndLine,EndCol) :- !,
1451		extract_line_col(Span,StartLine,StartCol,EndLine,EndCol).
1452		extract_line_col(Pos,_,_,_,_) :- is_symbolic_position(Pos),!,fail. % cannot extract line/col infos
1453		%extract_line_col(Struct,StartLine,StartCol,EndLine,EndCol) :-
1454		% is_argument_of_compound_term(Struct,Arg),
1455		% functor(Arg,FF,NN),functor(Struct,FS,NS), write(detected(FF,NN,in,FS,NS)),nl,trace,
1456		% /* recursively look for error spans inside */
1457		% extract_line_col(Arg,StartLine,StartCol,EndLine,EndCol),!.
1458		%extract_line_col(S,_,_,_,_) :- print('COULD NOT EXTRACT LINE/COL INFO: '), print(S),
1459		% functor(S,F,N), print(' '),print(F/N),nl,nl,fail.
1460
1461		%:- use_module(library(between),[between/3]).
1462		%is_argument_of_compound_term(Term,Arg) :- functor(Term,_,Arity),
1463		% between(1,Arity,ArgNr), arg(ArgNr,Term,Arg),
1464		% % this is quite dangerous, and possibly expensive
1465		% ground(Arg).
1466
1467		is_symbolic_position(rodinpos(_,_)).
1468		is_symbolic_position(rodinpos(_,_,_)).
1469		is_symbolic_position(rodin_derived_context_pos(_,_,_)).
1470		is_symbolic_position(label(_)).
1471
1472
1473		/* For TCL TK: extract all line_col information in one go and in 4 lists */
1474		extract_all_line_col(Span, StartLineList,StartColList,EndLineList,EndColList) :-
1475		findall(lc(SL,SC,EL,EC), extract_line_col(Span,SL,SC,EL,EC),All),
1476		%print(all(All,Span)),nl,
1477		split_lc(All,StartLineList,StartColList,EndLineList,EndColList).
1478
1479		split_lc([], [],[],[],[]).
1480		split_lc([lc(SL,SC,EL,EC)|T],[SL|T1],[SC|T2],[EL|T3],[EC|T4]) :-
1481		split_lc(T,T1,T2,T3,T4).
1482
1483		% TO DO: merge with line_col and in Tcl/Tk use info to highlight proper file !
1484
1485		% a version of extract_file_name with options:
1486		extract_file_name_with_opts(Pos,Filename,Opts) :- member(relative_file_name,Opts),!,
1487		extract_relative_file_name(Pos,Filename).
1488		extract_file_name_with_opts(Pos,Filename,Opts) :- member(tail_file_name,Opts),!,
1489		extract_tail_file_name(Pos,Filename).
1490		extract_file_name_with_opts(Pos,Filename,_) :-
1491		extract_file_name(Pos,Filename).
1492
1493		% TODO: maybe add a preference to always get full filename path (cf always_print_filename in translate)
1494		% TODO: do not show filename if there is only one file ?
1495		extract_relative_file_name(Pos,RelFilename) :-
1496		extract_file_name(Pos,Filename),
1497		(specfile:currently_opened_file_status(Main,_),
1498		tools:get_parent_directory(Main,MainDir),
1499		tools:gen_relative_path(Filename,MainDir,Rel)
1500		-> RelFilename = Rel
1501		; RelFilename = Filename).
1502		extract_file_name(Pos,Filename) :-
1503		extract_valid_file_number_and_name(Pos,_,Filename),
1504		Filename \=null. % Filename = null occurs in eval_strings !?
1505		extract_tail_file_name(Pos,Filename) :-
1506		extract_valid_file_number_and_name(Pos,_,FullFilename),
1507		tools:get_tail_filename(FullFilename,Filename).
1508		extract_subsidiary_tail_file_name(Pos,Filename) :-
1509		extract_valid_file_number_and_name(Pos,Nr,FullFilename),
1510		not_main_file(Nr,FullFilename),
1511		tools:get_tail_filename(FullFilename,Filename).
1512
1513		extract_valid_file_number_and_name(Pos,Nr,Filename) :-
1514		extract_file_number_and_name(Pos,Nr,Filename),
1515		valid_filename(Filename).
1516		valid_filename(F) :- atom(F). % not unknown(-1) which can come from REPL
1517		% should we detect null here?
1518
1519		% a version of extract_line_col which fails if the primary error location is not in the main file
1520		extract_primary_line_col_for_main_file(Span,Line,Col,EndLine,EndCol) :-
1521		\+((extract_file_number_and_name(Span,Nr,FullFilename),
1522		not_main_file(Nr,FullFilename))),
1523		extract_line_col(Span,Line,Col,EndLine,EndCol).
1524
1525		% a version of extract_line_col which fails if the error or subsidiary location is not in the main file
1526		extract_line_col_for_main_file(Span,Line,Col,EndLine,EndCol) :-
1527		(extract_file_number_and_name(Span,Nr,FullFilename),
1528		not_main_file(Nr,FullFilename)
1529		-> extract_additional_pos_and_descr(Span,SubPos,_,[]),
1530		extract_line_col_for_main_file(SubPos,Line,Col,EndLine,EndCol)
1531		; extract_line_col(Span,Line,Col,EndLine,EndCol)
1532		).
1533
1534		extract_file_number_and_name(V,_,_) :- var(V),!,fail.
1535		extract_file_number_and_name(value(_),_,_) :- !,fail.
1536		extract_file_number_and_name(pos_context(A,_,_), Filenumber,Filename) :- !,
1537		extract_file_number_and_name(A, Filenumber,Filename).
1538		extract_file_number_and_name(span_predicate(P,_,_), Filenumber,Filename) :- !,
1539		extract_file_number_and_name(P, Filenumber,Filename).
1540		extract_file_number_and_name(Pos, ResFileNr,Res) :-
1541		get_position_filenumber(Pos,Filenumber),!,
1542		(get_filename(Filenumber,Filename)
1543		-> ResFileNr=Filenumber,Res=Filename
1544		; ResFileNr=Filenumber,Res=unknown(Filenumber) % unknown(-1) which can come from REPL
1545		).
1546		extract_file_number_and_name(src_span(_,Filename,_,_,_,_,_,_), ResFileNr, Res) :- !,ResFileNr=unknown, Res=Filename.
1547		extract_file_number_and_name(src_span(_,_,_, _,_,_), _ResFileNr, _Res) :- !,fail. % src_span/6, No file stored
1548		extract_file_number_and_name(src_position_with_filename(_,_,_,Filename), ResFileNr, Res) :- !,ResFileNr=unknown,Res=Filename.
1549		extract_file_number_and_name(src_position_with_filename_and_ec(_,_,_,_,Filename), ResFileNr, Res) :- !,ResFileNr=unknown,Res=Filename.
1550		extract_file_number_and_name(section(RodinFilename), ResFileNr, Res) :- !,ResFileNr=unknown,Res=RodinFilename.
1551		extract_file_number_and_name([H|T],Filenumber,Filename) :- !,
1552		posinfo_member(Arg,[H|T]),
1553		extract_file_number_and_name(Arg,Filenumber,Filename),!.
1554		extract_file_number_and_name(closure(_,_,B),Filenumber,Filename) :- !,
1555		extract_file_number_and_name(B,Filenumber,Filename).
1556		extract_file_number_and_name(b(E,_,Infos),Filenumber,Filename) :- !,
1557		(extract_file_number_and_name(Infos,Filenumber,Filename) -> true
1558		; first_sub_expr(E,A) -> extract_file_number_and_name(A,Filenumber,Filename)).
1559		extract_file_number_and_name(span_context(Span,_),Filenumber,Filename) :- !,
1560		extract_file_number_and_name(Span,Filenumber,Filename).
1561		%extract_file_number_and_name(Struct,Filenumber,Filename) :-
1562		% /* recursively look for error spans inside */
1563		% is_argument_of_compound_term(Struct,Arg),
1564		% extract_file_number_and_name(Arg,Filenumber,Filename),!.
1565
1566	?	definite_posinfo_member(POS,Args) :- member(nodeid(POS),Args).
1567		posinfo_member(Arg,Args) :- % look for a nodeid(.) member
1568	?	(member(nodeid(POS),Args) -> Arg=POS). % no longer allow other members in lists ; member(Arg,Args)).
1569
1570		%:- use_module(bmachine,[b_get_all_used_filenames/1,b_get_main_filenumber/1]).
1571		position_is_not_in_main_file(Pos) :-
1572		get_position_filenumber(Pos,Filenumber),!, % B position info
1573		not_main_filenumber(Filenumber).
1574		position_is_not_in_main_file(src_span(_,Filename,_,_,_,_,_,_)) :- !,
1575		specfile:currently_opened_file_status(Main,_), Main \= Filename.
1576		position_is_not_in_main_file(src_position_with_filename(_,_,_,Filename)) :- !,
1577		specfile:currently_opened_file_status(Main,_), Main \= Filename.
1578		position_is_not_in_main_file(src_position_with_filename_ec(_,_,_,_,Filename)) :- !,
1579		specfile:currently_opened_file_status(Main,_), Main \= Filename.
1580		position_is_not_in_main_file(Struct) :- \+ atomic(Struct), Struct =.. [_|Args],
1581		/* recursively look for error spans inside */
1582	?	member(Arg,Args), position_is_not_in_main_file(Arg),!.
1583
1584
1585		not_main_file(Filenumber,_) :- number(Filenumber),!, % B Position info
1586		not_main_filenumber(Filenumber).
1587		not_main_file(_,Filename) :- % probably CSP position info; or unknown
1588		specfile:currently_opened_file_status(Main,_),
1589		\+ same_file_name(Main,Filename). %Main \= Filename.
1590
1591		:- use_module(tools,[get_tail_filename/2]).
1592		same_file_name(F1,F2) :-
1593		(F1=F2 -> true
1594		; atom(F1), atom(F2), % we can have a non-atomic name like package(event_b_project)
1595		get_tail_filename(F1,T1),
1596		get_tail_filename(F2,T2), T1=T2).
1597
1598		not_main_filenumber(Filenumber) :-
1599		(bmachine:b_get_main_filenumber(MainFN) -> MainFN \= Filenumber
1600		; true). % there is no main file number, this must be an additionally loaded file (e.g., VisB .def file)
1601
1602		% ---------------------------------
1603
1604
1605
1606		% find a sub-position matching a given target like context_pos
1607		find_sub_position_match(Pos,Target) :- Target=Pos,!.
1608		find_sub_position_match(b(E,_,Infos),Target) :- !,
1609		(find_sub_position_match(Infos,Target) -> true
1610		; first_sub_expr(E,A),find_sub_position_match(A,Target)).
1611		find_sub_position_match(span_predicate(P,_,_),Target) :- !,
1612		find_sub_position_match(P,Target).
1613		find_sub_position_match([H|T],Target) :- !,
1614		posinfo_member(N,[H|T]),
1615		find_sub_position_match(N,Target).
1616		find_sub_position_match(closure(_,_,B),Target) :- !,
1617		find_sub_position_match(B,Target).
1618
1619		extract_pos_context(Span,MainPos,Context,CtxtPos) :-
1620		find_sub_position_match(Span,pos_context(M,C,P)),!,
1621		MainPos=M, Context=C, CtxtPos=P.
1622
1623		% extract additional information about error span, e.g., Definition call context, other spans,...
1624		extract_additional_description(Span,FullDesc) :-
1625	?	extract_additional_pos_and_descr(Span,_Position,FullDesc,[]).
1626
1627		extract_additional_pos_and_descr(Span,CtxtPos,FullDesc,Opts) :-
1628		extract_pos_context(Span,MainPos,Context,CtxtPos),
1629		%nl,print(pos_context(MainPos,Context,CtxtPos)),nl,
1630	?	extract_context_msg(Context,MainPos,CMsg,Opts),
1631		(extract_span_description_with_opts(CtxtPos,PosMsg,Opts)
1632		-> (member(inner_context_separator(_,AT),Opts) -> true ; AT = ' at '),
1633		ajoin([CMsg,AT,PosMsg],FullDesc)
1634		; FullDesc=CMsg). % no position info available
1635
1636		extract_context_msg(call_stack(Stack),MainPos,Msg,_Opts) :- !,
1637	?	translate:translate_call_stack([top_level_call(MainPos)|Stack],Msg).
1638		% dynamic call stack; we add subsidiary DEFINITION calls to the Call stack
1639		% see result e.g., for public_examples/B/FeatureChecks/DEFINITIONS/DefCallStackDisplay.mch
1640		% TODO: should we also add_inner_context_description for use-cases like Atom editor
1641		extract_context_msg(definition_call(Name),MainPos,Msg,Opts) :-
1642		!, % static Definition macro expansion call stack
1643		(member(compact_pos_info,Opts)
1644		-> ajoin(['call of ',Name],OuterMsg)
1645		; ajoin(['DEFINITION call of ',Name],OuterMsg)
1646		),
1647		add_inner_context_description(MainPos,OuterMsg,Msg,Opts).
1648		extract_context_msg(C,MainPos,Msg,Opts) :- ajoin(['CONTEXT: ',C],OuterMsg),
1649		add_inner_context_description(MainPos,OuterMsg,Msg,Opts).
1650
1651
1652		add_inner_context_description(Span,OuterCMsg,FullDesc,Opts) :-
1653		% used to have this check: Span = pos_context(MainPos,Context,CtxtPos),
1654		extract_additional_pos_and_descr(Span,_Pos,InnerCMsg,Opts),!,
1655		(member(inner_context_separator(WITHIN,_),Opts) -> true ; WITHIN = ' within '),
1656		ajoin([InnerCMsg,WITHIN,OuterCMsg],FullDesc).
1657		add_inner_context_description(_,FullDesc,FullDesc,_).
1658
1659		% try and extract a definition call stack
1660		extract_definition_call_stack(pos_context(_Main,definition_call(Name),AuxPos),[Name|T]) :- !,
1661		extract_definition_call_stack(AuxPos,T).
1662		extract_definition_call_stack(_,[]).
1663
1664		% get definition call stack as atom
1665		extract_definition_call_stack_desc(CallPos,CSString) :-
1666		extract_definition_call_stack(CallPos,DefCallStack),
1667		(DefCallStack=[] -> CSString = ''
1668		; reverse(DefCallStack,RS),ajoin_with_sep(RS,'->',DefCallStackTxt),
1669		ajoin([' via ',DefCallStackTxt],CSString)
1670		).
1671		% ---------------------------------
1672
1673		% Get Source Position Info string for use in Tcl/Tk tables (column must be called 'Source'):
1674		get_tk_table_position_info(Span,PosStr) :-
1675		extract_line_col_for_main_file(Span,StartRow,StartCol,EndRow,EndCol), !,
1676		ajoin([' at line ',StartRow,':',StartCol,' - ', EndRow, ':', EndCol],PosStr). % recognised by Tk Table viewer
1677		get_tk_table_position_info(Span,PosStr) :- extract_span_description(Span,PosStr),!.
1678		get_tk_table_position_info(_,'').
1679
1680
1681		% ---------------------------------
1682
1683		:- dynamic backed_up_error/4.
1684
1685		% copy current error facts into backed_up_error facts
1686		backup_errors :-
1687		retractall(backed_up_error(_,_,_,_)),
1688		logged_error(Source,S,TContext,Span),
1689		assertz(backed_up_error(Source,S,TContext,Span)),
1690		fail.
1691		backup_errors.
1692
1693		% ---------------------------------
1694
1695		:- dynamic error_manager_silent_mode/1.
1696		% separate from debug:silent_mode to avoid dependency to debug module
1697		error_manager_silent_mode(off).
1698
1699		set_error_manager_silent_mode(X) :- retractall(error_manager_silent_mode(_)),
1700		assertz(error_manager_silent_mode(X)).
1701
1702
1703		formatsilentmsg(Stream,FS,Args) :- error_manager_silent_mode(off) -> format(Stream,FS,Args) ; true.
1704
1705		% -------------------------------------------
1706
1707		:- use_module(eventhandling,[register_event_listener/3]).
1708		:- register_event_listener(reset_prob,reset_errors,
1709		'Reset Error Manager just like after starup_prob (except total_number_of_errors)').