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