37
38:- module('$messages',
39 [ print_message/2, 40 print_message_lines/3, 41 message_to_string/2 42 ]). 43
44:- multifile
45 prolog:message//1, 46 prolog:error_message//1, 47 prolog:message_context//1, 48 prolog:deprecated//1, 49 prolog:message_location//1, 50 prolog:message_line_element/2. 51:- '$hide'((
52 prolog:message//1,
53 prolog:error_message//1,
54 prolog:message_context//1,
55 prolog:deprecated//1,
56 prolog:message_location//1,
57 prolog:message_line_element/2)). 59:- multifile
60 prolog:message//2, 61 prolog:error_message//2, 62 prolog:message_context//2, 63 prolog:message_location//2, 64 prolog:deprecated//2. 65:- '$hide'((
66 prolog:message//2,
67 prolog:error_message//2,
68 prolog:message_context//2,
69 prolog:deprecated//2,
70 prolog:message_location//2)). 71
72:- discontiguous
73 prolog_message/3. 74
75:- public
76 translate_message//1, 77 prolog:translate_message//1. 78
79:- create_prolog_flag(message_context, [thread], []). 80
102
103prolog:translate_message(Term) -->
104 translate_message(Term).
105
110
111translate_message(Term) -->
112 { nonvar(Term) },
113 ( { message_lang(Lang) },
114 prolog:message(Lang, Term)
115 ; prolog:message(Term)
116 ),
117 !.
118translate_message(Term) -->
119 { nonvar(Term) },
120 translate_message2(Term),
121 !.
122translate_message(Term) -->
123 { nonvar(Term),
124 Term = error(_, _)
125 },
126 [ 'Unknown exception: ~p'-[Term] ].
127translate_message(Term) -->
128 [ 'Unknown message: ~p'-[Term] ].
129
130translate_message2(Term) -->
131 prolog_message(Term).
132translate_message2(error(resource_error(stack), Context)) -->
133 !,
134 out_of_stack(Context).
135translate_message2(error(resource_error(tripwire(Wire, Context)), _)) -->
136 !,
137 tripwire_message(Wire, Context).
138translate_message2(error(existence_error(reset, Ball), SWI)) -->
139 swi_location(SWI),
140 tabling_existence_error(Ball, SWI).
141translate_message2(error(ISO, SWI)) -->
142 swi_location(SWI),
143 term_message(ISO),
144 swi_extra(SWI).
145translate_message2('$aborted') -->
146 [ 'Execution Aborted' ].
147translate_message2(message_lines(Lines), L, T) :- 148 make_message_lines(Lines, L, T).
149translate_message2(format(Fmt, Args)) -->
150 [ Fmt-Args ].
151
152make_message_lines([], T, T) :- !.
153make_message_lines([Last], ['~w'-[Last]|T], T) :- !.
154make_message_lines([L0|LT], ['~w'-[L0],nl|T0], T) :-
155 make_message_lines(LT, T0, T).
156
162
163:- public term_message//1. 164term_message(Term) -->
165 {var(Term)},
166 !,
167 [ 'Unknown error term: ~p'-[Term] ].
168term_message(Term) -->
169 { message_lang(Lang) },
170 prolog:error_message(Lang, Term),
171 !.
172term_message(Term) -->
173 prolog:error_message(Term),
174 !.
175term_message(Term) -->
176 iso_message(Term).
177term_message(Term) -->
178 swi_message(Term).
179term_message(Term) -->
180 [ 'Unknown error term: ~p'-[Term] ].
181
182iso_message(resource_error(c_stack)) -->
183 out_of_c_stack.
184iso_message(resource_error(Missing)) -->
185 [ 'Not enough resources: ~w'-[Missing] ].
186iso_message(type_error(evaluable, Actual)) -->
187 { callable(Actual) },
188 [ 'Arithmetic: `~p'' is not a function'-[Actual] ].
189iso_message(type_error(free_of_attvar, Actual)) -->
190 [ 'Type error: `~W'' contains attributed variables'-
191 [Actual,[portray(true), attributes(portray)]] ].
192iso_message(type_error(Expected, Actual)) -->
193 [ 'Type error: `~w'' expected, found `~p'''-[Expected, Actual] ],
194 type_error_comment(Expected, Actual).
195iso_message(domain_error(Domain, Actual)) -->
196 [ 'Domain error: '-[] ], domain(Domain),
197 [ ' expected, found `~p'''-[Actual] ].
198iso_message(instantiation_error) -->
199 [ 'Arguments are not sufficiently instantiated' ].
200iso_message(uninstantiation_error(Var)) -->
201 [ 'Uninstantiated argument expected, found ~p'-[Var] ].
202iso_message(representation_error(What)) -->
203 [ 'Cannot represent due to `~w'''-[What] ].
204iso_message(permission_error(Action, Type, Object)) -->
205 permission_error(Action, Type, Object).
206iso_message(evaluation_error(Which)) -->
207 [ 'Arithmetic: evaluation error: `~p'''-[Which] ].
208iso_message(existence_error(procedure, Proc)) -->
209 [ 'Unknown procedure: ~q'-[Proc] ],
210 unknown_proc_msg(Proc).
211iso_message(existence_error(answer_variable, Var)) -->
212 [ '$~w was not bound by a previous query'-[Var] ].
213iso_message(existence_error(matching_rule, Goal)) -->
214 [ 'No rule matches ~p'-[Goal] ].
215iso_message(existence_error(Type, Object)) -->
216 [ '~w `~p'' does not exist'-[Type, Object] ].
217iso_message(existence_error(export, PI, module(M))) --> 218 [ 'Module ', ansi(code, '~q', [M]), ' does not export ',
219 ansi(code, '~q', [PI]) ].
220iso_message(existence_error(Type, Object, In)) --> 221 [ '~w `~p'' does not exist in ~p'-[Type, Object, In] ].
222iso_message(busy(Type, Object)) -->
223 [ '~w `~p'' is busy'-[Type, Object] ].
224iso_message(syntax_error(swi_backslash_newline)) -->
225 [ 'Deprecated ... \\<newline><white>*. Use \\c' ].
226iso_message(syntax_error(Id)) -->
227 [ 'Syntax error: ' ],
228 syntax_error(Id).
229iso_message(occurs_check(Var, In)) -->
230 [ 'Cannot unify ~p with ~p: would create an infinite tree'-[Var, In] ].
231
236
237permission_error(Action, built_in_procedure, Pred) -->
238 { user_predicate_indicator(Pred, PI)
239 },
240 [ 'No permission to ~w built-in predicate `~p'''-[Action, PI] ],
241 ( {Action \== export}
242 -> [ nl,
243 'Use :- redefine_system_predicate(+Head) if redefinition is intended'
244 ]
245 ; []
246 ).
247permission_error(import_into(Dest), procedure, Pred) -->
248 [ 'No permission to import ~p into ~w'-[Pred, Dest] ].
249permission_error(Action, static_procedure, Proc) -->
250 [ 'No permission to ~w static procedure `~p'''-[Action, Proc] ],
251 defined_definition('Defined', Proc).
252permission_error(input, stream, Stream) -->
253 [ 'No permission to read from output stream `~p'''-[Stream] ].
254permission_error(output, stream, Stream) -->
255 [ 'No permission to write to input stream `~p'''-[Stream] ].
256permission_error(input, text_stream, Stream) -->
257 [ 'No permission to read bytes from TEXT stream `~p'''-[Stream] ].
258permission_error(output, text_stream, Stream) -->
259 [ 'No permission to write bytes to TEXT stream `~p'''-[Stream] ].
260permission_error(input, binary_stream, Stream) -->
261 [ 'No permission to read characters from binary stream `~p'''-[Stream] ].
262permission_error(output, binary_stream, Stream) -->
263 [ 'No permission to write characters to binary stream `~p'''-[Stream] ].
264permission_error(open, source_sink, alias(Alias)) -->
265 [ 'No permission to reuse alias "~p": already taken'-[Alias] ].
266permission_error(tnot, non_tabled_procedure, Pred) -->
267 [ 'The argument of tnot/1 is not tabled: ~p'-[Pred] ].
268permission_error(assert, procedure, Pred) -->
269 { '$pi_head'(Pred, Head),
270 predicate_property(Head, ssu)
271 },
272 [ '~p: an SSU (Head => Body) predicate cannot have normal Prolog clauses'-
273 [Pred] ].
274permission_error(Action, Type, Object) -->
275 [ 'No permission to ~w ~w `~p'''-[Action, Type, Object] ].
276
277
278unknown_proc_msg(_:(^)/2) -->
279 !,
280 unknown_proc_msg((^)/2).
281unknown_proc_msg((^)/2) -->
282 !,
283 [nl, ' ^/2 can only appear as the 2nd argument of setof/3 and bagof/3'].
284unknown_proc_msg((:-)/2) -->
285 !,
286 [nl, ' Rules must be loaded from a file'],
287 faq('ToplevelMode').
288unknown_proc_msg((=>)/2) -->
289 !,
290 [nl, ' Rules must be loaded from a file'],
291 faq('ToplevelMode').
292unknown_proc_msg((:-)/1) -->
293 !,
294 [nl, ' Directives must be loaded from a file'],
295 faq('ToplevelMode').
296unknown_proc_msg((?-)/1) -->
297 !,
298 [nl, ' ?- is the Prolog prompt'],
299 faq('ToplevelMode').
300unknown_proc_msg(Proc) -->
301 { dwim_predicates(Proc, Dwims) },
302 ( {Dwims \== []}
303 -> [nl, ' However, there are definitions for:', nl],
304 dwim_message(Dwims)
305 ; []
306 ).
307
308dependency_error(shared(Shared), private(Private)) -->
309 [ 'Shared table for ~p may not depend on private ~p'-[Shared, Private] ].
310dependency_error(Dep, monotonic(On)) -->
311 { '$pi_head'(PI, Dep),
312 '$pi_head'(MPI, On)
313 },
314 [ 'Dependent ~p on monotonic predicate ~p is not monotonic or incremental'-
315 [PI, MPI]
316 ].
317
318faq(Page) -->
319 [nl, ' See FAQ at https://www.swi-prolog.org/FAQ/', Page, '.html' ].
320
(_Expected, Actual) -->
322 { type_of(Actual, Type),
323 ( sub_atom(Type, 0, 1, _, First),
324 memberchk(First, [a,e,i,o,u])
325 -> Article = an
326 ; Article = a
327 )
328 },
329 [ ' (~w ~w)'-[Article, Type] ].
330
331type_of(Term, Type) :-
332 ( attvar(Term) -> Type = attvar
333 ; var(Term) -> Type = var
334 ; atom(Term) -> Type = atom
335 ; integer(Term) -> Type = integer
336 ; string(Term) -> Type = string
337 ; Term == [] -> Type = empty_list
338 ; blob(Term, BlobT) -> blob_type(BlobT, Type)
339 ; rational(Term) -> Type = rational
340 ; float(Term) -> Type = float
341 ; is_stream(Term) -> Type = stream
342 ; is_dict(Term) -> Type = dict
343 ; is_list(Term) -> Type = list
344 ; cyclic_term(Term) -> Type = cyclic
345 ; compound(Term) -> Type = compound
346 ; Type = unknown
347 ).
348
349blob_type(BlobT, Type) :-
350 atom_concat(BlobT, '_reference', Type).
351
352syntax_error(end_of_clause) -->
353 [ 'Unexpected end of clause' ].
354syntax_error(end_of_clause_expected) -->
355 [ 'End of clause expected' ].
356syntax_error(end_of_file) -->
357 [ 'Unexpected end of file' ].
358syntax_error(end_of_file_in_block_comment) -->
359 [ 'End of file in /* ... */ comment' ].
360syntax_error(end_of_file_in_quoted(Quote)) -->
361 [ 'End of file in quoted ' ],
362 quoted_type(Quote).
363syntax_error(illegal_number) -->
364 [ 'Illegal number' ].
365syntax_error(long_atom) -->
366 [ 'Atom too long (see style_check/1)' ].
367syntax_error(long_string) -->
368 [ 'String too long (see style_check/1)' ].
369syntax_error(operator_clash) -->
370 [ 'Operator priority clash' ].
371syntax_error(operator_expected) -->
372 [ 'Operator expected' ].
373syntax_error(operator_balance) -->
374 [ 'Unbalanced operator' ].
375syntax_error(quoted_punctuation) -->
376 [ 'Operand expected, unquoted comma or bar found' ].
377syntax_error(list_rest) -->
378 [ 'Unexpected comma or bar in rest of list' ].
379syntax_error(cannot_start_term) -->
380 [ 'Illegal start of term' ].
381syntax_error(punct(Punct, End)) -->
382 [ 'Unexpected `~w\' before `~w\''-[Punct, End] ].
383syntax_error(undefined_char_escape(C)) -->
384 [ 'Unknown character escape in quoted atom or string: `\\~w\''-[C] ].
385syntax_error(void_not_allowed) -->
386 [ 'Empty argument list "()"' ].
387syntax_error(Message) -->
388 [ '~w'-[Message] ].
389
390quoted_type('\'') --> [atom].
391quoted_type('\"') --> { current_prolog_flag(double_quotes, Type) }, [Type-[]].
392quoted_type('\`') --> { current_prolog_flag(back_quotes, Type) }, [Type-[]].
393
394domain(range(Low,High)) -->
395 !,
396 ['[~q..~q]'-[Low,High] ].
397domain(Domain) -->
398 ['`~w\''-[Domain] ].
399
404
405tabling_existence_error(Ball, Context) -->
406 { table_shift_ball(Ball) },
407 [ 'Tabling dependency error' ],
408 swi_extra(Context).
409
410table_shift_ball(dependency(_Head)).
411table_shift_ball(dependency(_Skeleton, _Trie, _Mono)).
412table_shift_ball(call_info(_Skeleton, _Status)).
413table_shift_ball(call_info(_GenSkeleton, _Skeleton, _Status)).
414
418
419dwim_predicates(Module:Name/_Arity, Dwims) :-
420 !,
421 findall(Dwim, dwim_predicate(Module:Name, Dwim), Dwims).
422dwim_predicates(Name/_Arity, Dwims) :-
423 findall(Dwim, dwim_predicate(user:Name, Dwim), Dwims).
424
425dwim_message([]) --> [].
426dwim_message([M:Head|T]) -->
427 { hidden_module(M),
428 !,
429 functor(Head, Name, Arity)
430 },
431 [ ' ~q'-[Name/Arity], nl ],
432 dwim_message(T).
433dwim_message([Module:Head|T]) -->
434 !,
435 { functor(Head, Name, Arity)
436 },
437 [ ' ~q'-[Module:Name/Arity], nl],
438 dwim_message(T).
439dwim_message([Head|T]) -->
440 {functor(Head, Name, Arity)},
441 [ ' ~q'-[Name/Arity], nl],
442 dwim_message(T).
443
444
445swi_message(io_error(Op, Stream)) -->
446 [ 'I/O error in ~w on stream ~p'-[Op, Stream] ].
447swi_message(thread_error(TID, false)) -->
448 [ 'Thread ~p died due to failure:'-[TID] ].
449swi_message(thread_error(TID, exception(Error))) -->
450 [ 'Thread ~p died abnormally:'-[TID], nl ],
451 translate_message(Error).
452swi_message(dependency_error(Tabled, DependsOn)) -->
453 dependency_error(Tabled, DependsOn).
454swi_message(shell(execute, Cmd)) -->
455 [ 'Could not execute `~w'''-[Cmd] ].
456swi_message(shell(signal(Sig), Cmd)) -->
457 [ 'Caught signal ~d on `~w'''-[Sig, Cmd] ].
458swi_message(format(Fmt, Args)) -->
459 [ Fmt-Args ].
460swi_message(signal(Name, Num)) -->
461 [ 'Caught signal ~d (~w)'-[Num, Name] ].
462swi_message(limit_exceeded(Limit, MaxVal)) -->
463 [ 'Exceeded ~w limit (~w)'-[Limit, MaxVal] ].
464swi_message(goal_failed(Goal)) -->
465 [ 'goal unexpectedly failed: ~p'-[Goal] ].
466swi_message(shared_object(_Action, Message)) --> 467 [ '~w'-[Message] ].
468swi_message(system_error(Error)) -->
469 [ 'error in system call: ~w'-[Error]
470 ].
471swi_message(system_error) -->
472 [ 'error in system call'
473 ].
474swi_message(failure_error(Goal)) -->
475 [ 'Goal failed: ~p'-[Goal] ].
476swi_message(timeout_error(Op, Stream)) -->
477 [ 'Timeout in ~w from ~p'-[Op, Stream] ].
478swi_message(not_implemented(Type, What)) -->
479 [ '~w `~p\' is not implemented in this version'-[Type, What] ].
480swi_message(context_error(nodirective, Goal)) -->
481 { goal_to_predicate_indicator(Goal, PI) },
482 [ 'Wrong context: ~p can only be used in a directive'-[PI] ].
483swi_message(context_error(edit, no_default_file)) -->
484 ( { current_prolog_flag(windows, true) }
485 -> [ 'Edit/0 can only be used after opening a \c
486 Prolog file by double-clicking it' ]
487 ; [ 'Edit/0 can only be used with the "-s file" commandline option'
488 ]
489 ),
490 [ nl, 'Use "?- edit(Topic)." or "?- emacs."' ].
491swi_message(context_error(function, meta_arg(S))) -->
492 [ 'Functions are not (yet) supported for meta-arguments of type ~q'-[S] ].
493swi_message(format_argument_type(Fmt, Arg)) -->
494 [ 'Illegal argument to format sequence ~~~w: ~p'-[Fmt, Arg] ].
495swi_message(format(Msg)) -->
496 [ 'Format error: ~w'-[Msg] ].
497swi_message(conditional_compilation_error(unterminated, File:Line)) -->
498 [ 'Unterminated conditional compilation from '-[], url(File:Line) ].
499swi_message(conditional_compilation_error(no_if, What)) -->
500 [ ':- ~w without :- if'-[What] ].
501swi_message(duplicate_key(Key)) -->
502 [ 'Duplicate key: ~p'-[Key] ].
503swi_message(initialization_error(failed, Goal, File:Line)) -->
504 !,
505 [ url(File:Line), ': ~p: false'-[Goal] ].
506swi_message(initialization_error(Error, Goal, File:Line)) -->
507 [ url(File:Line), ': ~p '-[Goal] ],
508 translate_message(Error).
509swi_message(determinism_error(PI, det, Found, property)) -->
510 ( { '$pi_head'(user:PI, Head),
511 predicate_property(Head, det)
512 }
513 -> [ 'Deterministic procedure ~p'-[PI] ]
514 ; [ 'Procedure ~p called from a deterministic procedure'-[PI] ]
515 ),
516 det_error(Found).
517swi_message(determinism_error(PI, det, fail, guard)) -->
518 [ 'Procedure ~p failed after $-guard'-[PI] ].
519swi_message(determinism_error(PI, det, fail, guard_in_caller)) -->
520 [ 'Procedure ~p failed after $-guard in caller'-[PI] ].
521swi_message(determinism_error(Goal, det, fail, goal)) -->
522 [ 'Goal ~p failed'-[Goal] ].
523swi_message(determinism_error(Goal, det, nondet, goal)) -->
524 [ 'Goal ~p succeeded with a choice point'-[Goal] ].
525swi_message(qlf_format_error(File, Message)) -->
526 [ '~w: Invalid QLF file: ~w'-[File, Message] ].
527swi_message(goal_expansion_error(bound, Term)) -->
528 [ 'Goal expansion bound a variable to ~p'-[Term] ].
529
530det_error(nondet) -->
531 [ ' succeeded with a choicepoint'- [] ].
532det_error(fail) -->
533 [ ' failed'- [] ].
534
535
540
541:- public swi_location//1. 542swi_location(X) -->
543 { var(X) },
544 !.
545swi_location(Context) -->
546 { message_lang(Lang) },
547 prolog:message_location(Lang, Context),
548 !.
549swi_location(Context) -->
550 prolog:message_location(Context),
551 !.
552swi_location(context(Caller, _Msg)) -->
553 { ground(Caller) },
554 !,
555 caller(Caller).
556swi_location(file(Path, Line, -1, _CharNo)) -->
557 !,
558 [ url(Path:Line), ': ' ].
559swi_location(file(Path, Line, LinePos, _CharNo)) -->
560 [ url(Path:Line:LinePos), ': ' ].
561swi_location(stream(Stream, Line, LinePos, CharNo)) -->
562 ( { is_stream(Stream),
563 stream_property(Stream, file_name(File))
564 }
565 -> swi_location(file(File, Line, LinePos, CharNo))
566 ; [ 'Stream ~w:~d:~d '-[Stream, Line, LinePos] ]
567 ).
568swi_location(autoload(File:Line)) -->
569 [ url(File:Line), ': ' ].
570swi_location(_) -->
571 [].
572
573caller(system:'$record_clause'/3) -->
574 !,
575 [].
576caller(Module:Name/Arity) -->
577 !,
578 ( { \+ hidden_module(Module) }
579 -> [ '~q:~q/~w: '-[Module, Name, Arity] ]
580 ; [ '~q/~w: '-[Name, Arity] ]
581 ).
582caller(Name/Arity) -->
583 [ '~q/~w: '-[Name, Arity] ].
584caller(Caller) -->
585 [ '~p: '-[Caller] ].
586
587
595
(X) -->
597 { var(X) },
598 !,
599 [].
600swi_extra(Context) -->
601 { message_lang(Lang) },
602 prolog:message_context(Lang, Context),
603 !.
604swi_extra(Context) -->
605 prolog:message_context(Context).
606swi_extra(context(_, Msg)) -->
607 { nonvar(Msg),
608 Msg \== ''
609 },
610 !,
611 swi_comment(Msg).
612swi_extra(string(String, CharPos)) -->
613 { sub_string(String, 0, CharPos, _, Before),
614 sub_string(String, CharPos, _, 0, After)
615 },
616 [ nl, '~w'-[Before], nl, '** here **', nl, '~w'-[After] ].
617swi_extra(_) -->
618 [].
619
(already_from(Module)) -->
621 !,
622 [ ' (already imported from ~q)'-[Module] ].
623swi_comment(directory(_Dir)) -->
624 !,
625 [ ' (is a directory)' ].
626swi_comment(not_a_directory(_Dir)) -->
627 !,
628 [ ' (is not a directory)' ].
629swi_comment(Msg) -->
630 [ ' (~w)'-[Msg] ].
631
632
633thread_context -->
634 { thread_self(Me), Me \== main, thread_property(Me, id(Id)) },
635 !,
636 ['[Thread ~w] '-[Id]].
637thread_context -->
638 [].
639
640 643
644prolog_message(welcome) -->
645 [ 'Welcome to SWI-Prolog (' ],
646 prolog_message(threads),
647 prolog_message(address_bits),
648 ['version ' ],
649 prolog_message(version),
650 [ ')', nl ],
651 prolog_message(copyright),
652 [ nl ],
653 translate_message(user_versions),
654 [ nl ],
655 prolog_message(documentaton),
656 [ nl, nl ].
657prolog_message(user_versions) -->
658 ( { findall(Msg, prolog:version_msg(Msg), Msgs),
659 Msgs \== []
660 }
661 -> [nl],
662 user_version_messages(Msgs)
663 ; []
664 ).
665prolog_message(deprecated(Term)) -->
666 { nonvar(Term) },
667 ( { message_lang(Lang) },
668 prolog:deprecated(Lang, Term)
669 -> []
670 ; prolog:deprecated(Term)
671 -> []
672 ; deprecated(Term)
673 ).
674prolog_message(unhandled_exception(E)) -->
675 { nonvar(E) },
676 [ 'Unhandled exception: ' ],
677 ( translate_message(E)
678 -> []
679 ; [ '~p'-[E] ]
680 ).
681
683
684prolog_message(initialization_error(_, E, File:Line)) -->
685 !,
686 [ url(File:Line),
687 ': Initialization goal raised exception:', nl
688 ],
689 translate_message(E).
690prolog_message(initialization_error(Goal, E, _)) -->
691 [ 'Initialization goal ~p raised exception:'-[Goal], nl ],
692 translate_message(E).
693prolog_message(initialization_failure(_Goal, File:Line)) -->
694 !,
695 [ url(File:Line),
696 ': Initialization goal failed'-[]
697 ].
698prolog_message(initialization_failure(Goal, _)) -->
699 [ 'Initialization goal failed: ~p'-[Goal]
700 ].
701prolog_message(initialization_exception(E)) -->
702 [ 'Prolog initialisation failed:', nl ],
703 translate_message(E).
704prolog_message(init_goal_syntax(Error, Text)) -->
705 !,
706 [ '-g ~w: '-[Text] ],
707 translate_message(Error).
708prolog_message(init_goal_failed(failed, @(Goal,File:Line))) -->
709 !,
710 [ url(File:Line), ': ~p: false'-[Goal] ].
711prolog_message(init_goal_failed(Error, @(Goal,File:Line))) -->
712 !,
713 [ url(File:Line), ': ~p '-[Goal] ],
714 translate_message(Error).
715prolog_message(init_goal_failed(failed, Text)) -->
716 !,
717 [ '-g ~w: false'-[Text] ].
718prolog_message(init_goal_failed(Error, Text)) -->
719 !,
720 [ '-g ~w: '-[Text] ],
721 translate_message(Error).
722prolog_message(goal_failed(Context, Goal)) -->
723 [ 'Goal (~w) failed: ~p'-[Context, Goal] ].
724prolog_message(no_current_module(Module)) -->
725 [ '~w is not a current module (created)'-[Module] ].
726prolog_message(commandline_arg_type(Flag, Arg)) -->
727 [ 'Bad argument to commandline option -~w: ~w'-[Flag, Arg] ].
728prolog_message(missing_feature(Name)) -->
729 [ 'This version of SWI-Prolog does not support ~w'-[Name] ].
730prolog_message(singletons(_Term, List)) -->
731 [ 'Singleton variables: ~w'-[List] ].
732prolog_message(multitons(_Term, List)) -->
733 [ 'Singleton-marked variables appearing more than once: ~w'-[List] ].
734prolog_message(profile_no_cpu_time) -->
735 [ 'No CPU-time info. Check the SWI-Prolog manual for details' ].
736prolog_message(non_ascii(Text, Type)) -->
737 [ 'Unquoted ~w with non-portable characters: ~w'-[Type, Text] ].
738prolog_message(io_warning(Stream, Message)) -->
739 { stream_property(Stream, position(Position)),
740 !,
741 stream_position_data(line_count, Position, LineNo),
742 stream_position_data(line_position, Position, LinePos),
743 ( stream_property(Stream, file_name(File))
744 -> Obj = File
745 ; Obj = Stream
746 )
747 },
748 [ '~p:~d:~d: ~w'-[Obj, LineNo, LinePos, Message] ].
749prolog_message(io_warning(Stream, Message)) -->
750 [ 'stream ~p: ~w'-[Stream, Message] ].
751prolog_message(option_usage(pldoc)) -->
752 [ 'Usage: --pldoc[=port]' ].
753prolog_message(interrupt(begin)) -->
754 [ 'Action (h for help) ? ', flush ].
755prolog_message(interrupt(end)) -->
756 [ 'continue' ].
757prolog_message(interrupt(trace)) -->
758 [ 'continue (trace mode)' ].
759prolog_message(unknown_in_module_user) -->
760 [ 'Using a non-error value for unknown in the global module', nl,
761 'causes most of the development environment to stop working.', nl,
762 'Please use :- dynamic or limit usage of unknown to a module.', nl,
763 'See https://www.swi-prolog.org/howto/database.html'
764 ].
765prolog_message(untable(PI)) -->
766 [ 'Reconsult: removed tabling for ~p'-[PI] ].
767
768
769 772
773prolog_message(modify_active_procedure(Who, What)) -->
774 [ '~p: modified active procedure ~p'-[Who, What] ].
775prolog_message(load_file(failed(user:File))) -->
776 [ 'Failed to load ~p'-[File] ].
777prolog_message(load_file(failed(Module:File))) -->
778 [ 'Failed to load ~p into module ~p'-[File, Module] ].
779prolog_message(load_file(failed(File))) -->
780 [ 'Failed to load ~p'-[File] ].
781prolog_message(mixed_directive(Goal)) -->
782 [ 'Cannot pre-compile mixed load/call directive: ~p'-[Goal] ].
783prolog_message(cannot_redefine_comma) -->
784 [ 'Full stop in clause-body? Cannot redefine ,/2' ].
785prolog_message(illegal_autoload_index(Dir, Term)) -->
786 [ 'Illegal term in INDEX file of directory ~w: ~w'-[Dir, Term] ].
787prolog_message(redefined_procedure(Type, Proc)) -->
788 [ 'Redefined ~w procedure ~p'-[Type, Proc] ],
789 defined_definition('Previously defined', Proc).
790prolog_message(declare_module(Module, abolish(Predicates))) -->
791 [ 'Loading module ~w abolished: ~p'-[Module, Predicates] ].
792prolog_message(import_private(Module, Private)) -->
793 [ 'import/1: ~p is not exported (still imported into ~q)'-
794 [Private, Module]
795 ].
796prolog_message(ignored_weak_import(Into, From:PI)) -->
797 [ 'Local definition of ~p overrides weak import from ~q'-
798 [Into:PI, From]
799 ].
800prolog_message(undefined_export(Module, PI)) -->
801 [ 'Exported procedure ~q:~q is not defined'-[Module, PI] ].
802prolog_message(no_exported_op(Module, Op)) -->
803 [ 'Operator ~q:~q is not exported (still defined)'-[Module, Op] ].
804prolog_message(discontiguous((-)/2,_)) -->
805 prolog_message(minus_in_identifier).
806prolog_message(discontiguous(Proc,Current)) -->
807 [ 'Clauses of ', ansi(code, '~p', [Proc]),
808 ' are not together in the source-file', nl ],
809 current_definition(Proc, 'Earlier definition at '),
810 [ 'Current predicate: ', ansi(code, '~p', [Current]), nl,
811 'Use ', ansi(code, ':- discontiguous ~p.', [Proc]),
812 ' to suppress this message'
813 ].
814prolog_message(decl_no_effect(Goal)) -->
815 [ 'Deprecated declaration has no effect: ~p'-[Goal] ].
816prolog_message(load_file(start(Level, File))) -->
817 [ '~|~t~*+Loading '-[Level] ],
818 load_file(File),
819 [ ' ...' ].
820prolog_message(include_file(start(Level, File))) -->
821 [ '~|~t~*+include '-[Level] ],
822 load_file(File),
823 [ ' ...' ].
824prolog_message(include_file(done(Level, File))) -->
825 [ '~|~t~*+included '-[Level] ],
826 load_file(File).
827prolog_message(load_file(done(Level, File, Action, Module, Time, Clauses))) -->
828 [ '~|~t~*+'-[Level] ],
829 load_file(File),
830 [ ' ~w'-[Action] ],
831 load_module(Module),
832 [ ' ~2f sec, ~D clauses'-[Time, Clauses] ].
833prolog_message(dwim_undefined(Goal, Alternatives)) -->
834 { goal_to_predicate_indicator(Goal, Pred)
835 },
836 [ 'Unknown procedure: ~q'-[Pred], nl,
837 ' However, there are definitions for:', nl
838 ],
839 dwim_message(Alternatives).
840prolog_message(dwim_correct(Into)) -->
841 [ 'Correct to: ~q? '-[Into], flush ].
842prolog_message(error(loop_error(Spec), file_search(Used))) -->
843 [ 'File search: too many levels of indirections on: ~p'-[Spec], nl,
844 ' Used alias expansions:', nl
845 ],
846 used_search(Used).
847prolog_message(minus_in_identifier) -->
848 [ 'The "-" character should not be used to separate words in an', nl,
849 'identifier. Check the SWI-Prolog FAQ for details.'
850 ].
851prolog_message(qlf(removed_after_error(File))) -->
852 [ 'Removed incomplete QLF file ~w'-[File] ].
853prolog_message(qlf(recompile(Spec,_Pl,_Qlf,Reason))) -->
854 [ '~p: recompiling QLF file'-[Spec] ],
855 qlf_recompile_reason(Reason).
856prolog_message(qlf(can_not_recompile(Spec,QlfFile,_Reason))) -->
857 [ '~p: can not recompile "~w" (access denied)'-[Spec, QlfFile], nl,
858 '\tLoading from source'-[]
859 ].
860prolog_message(qlf(system_lib_out_of_date(Spec,QlfFile))) -->
861 [ '~p: can not recompile "~w" (access denied)'-[Spec, QlfFile], nl,
862 '\tLoading QlfFile'-[]
863 ].
864prolog_message(redefine_module(Module, OldFile, File)) -->
865 [ 'Module "~q" already loaded from ~w.'-[Module, OldFile], nl,
866 'Wipe and reload from ~w? '-[File], flush
867 ].
868prolog_message(redefine_module_reply) -->
869 [ 'Please answer y(es), n(o) or a(bort)' ].
870prolog_message(reloaded_in_module(Absolute, OldContext, LM)) -->
871 [ '~w was previously loaded in module ~w'-[Absolute, OldContext], nl,
872 '\tnow it is reloaded into module ~w'-[LM] ].
873prolog_message(expected_layout(Expected, Pos)) -->
874 [ 'Layout data: expected ~w, found: ~p'-[Expected, Pos] ].
875
876defined_definition(Message, Spec) -->
877 { strip_module(user:Spec, M, Name/Arity),
878 functor(Head, Name, Arity),
879 predicate_property(M:Head, file(File)),
880 predicate_property(M:Head, line_count(Line))
881 },
882 !,
883 [ nl, '~w at '-[Message], url(File:Line) ].
884defined_definition(_, _) --> [].
885
886used_search([]) -->
887 [].
888used_search([Alias=Expanded|T]) -->
889 [ ' file_search_path(~p, ~p)'-[Alias, Expanded], nl ],
890 used_search(T).
891
892load_file(file(Spec, _Path)) -->
893 ( {atomic(Spec)}
894 -> [ '~w'-[Spec] ]
895 ; [ '~p'-[Spec] ]
896 ).
899
900load_module(user) --> !.
901load_module(system) --> !.
902load_module(Module) -->
903 [ ' into ~w'-[Module] ].
904
905goal_to_predicate_indicator(Goal, PI) :-
906 strip_module(Goal, Module, Head),
907 callable_name_arity(Head, Name, Arity),
908 user_predicate_indicator(Module:Name/Arity, PI).
909
910callable_name_arity(Goal, Name, Arity) :-
911 compound(Goal),
912 !,
913 compound_name_arity(Goal, Name, Arity).
914callable_name_arity(Goal, Goal, 0) :-
915 atom(Goal).
916
917user_predicate_indicator(Module:PI, PI) :-
918 hidden_module(Module),
919 !.
920user_predicate_indicator(PI, PI).
921
922hidden_module(user) :- !.
923hidden_module(system) :- !.
924hidden_module(M) :-
925 sub_atom(M, 0, _, _, $).
926
927current_definition(Proc, Prefix) -->
928 { pi_uhead(Proc, Head),
929 predicate_property(Head, file(File)),
930 predicate_property(Head, line_count(Line))
931 },
932 [ '~w'-[Prefix], url(File:Line), nl ].
933current_definition(_, _) --> [].
934
935pi_uhead(Module:Name/Arity, Module:Head) :-
936 !,
937 atom(Module), atom(Name), integer(Arity),
938 functor(Head, Name, Arity).
939pi_uhead(Name/Arity, user:Head) :-
940 atom(Name), integer(Arity),
941 functor(Head, Name, Arity).
942
943qlf_recompile_reason(old) -->
944 !,
945 [ ' (out of date)'-[] ].
946qlf_recompile_reason(_) -->
947 [ ' (incompatible with current Prolog version)'-[] ].
948
949prolog_message(file_search(cache(Spec, _Cond), Path)) -->
950 [ 'File search: ~p --> ~p (cache)'-[Spec, Path] ].
951prolog_message(file_search(found(Spec, Cond), Path)) -->
952 [ 'File search: ~p --> ~p OK ~p'-[Spec, Path, Cond] ].
953prolog_message(file_search(tried(Spec, Cond), Path)) -->
954 [ 'File search: ~p --> ~p NO ~p'-[Spec, Path, Cond] ].
955
956 959
960prolog_message(agc(start)) -->
961 thread_context,
962 [ 'AGC: ', flush ].
963prolog_message(agc(done(Collected, Remaining, Time))) -->
964 [ at_same_line,
965 'reclaimed ~D atoms in ~3f sec. (remaining: ~D)'-
966 [Collected, Time, Remaining]
967 ].
968prolog_message(cgc(start)) -->
969 thread_context,
970 [ 'CGC: ', flush ].
971prolog_message(cgc(done(CollectedClauses, _CollectedBytes,
972 RemainingBytes, Time))) -->
973 [ at_same_line,
974 'reclaimed ~D clauses in ~3f sec. (pending: ~D bytes)'-
975 [CollectedClauses, Time, RemainingBytes]
976 ].
977
978 981
982out_of_stack(Context) -->
983 { human_stack_size(Context.localused, Local),
984 human_stack_size(Context.globalused, Global),
985 human_stack_size(Context.trailused, Trail),
986 human_stack_size(Context.stack_limit, Limit),
987 LCO is (100*(Context.depth - Context.environments))/Context.depth
988 },
989 [ 'Stack limit (~s) exceeded'-[Limit], nl,
990 ' Stack sizes: local: ~s, global: ~s, trail: ~s'-[Local,Global,Trail], nl,
991 ' Stack depth: ~D, last-call: ~0f%, Choice points: ~D'-
992 [Context.depth, LCO, Context.choicepoints], nl
993 ],
994 overflow_reason(Context, Resolve),
995 resolve_overflow(Resolve).
996
997human_stack_size(Size, String) :-
998 Size < 100,
999 format(string(String), '~dKb', [Size]).
1000human_stack_size(Size, String) :-
1001 Size < 100 000,
1002 Value is Size / 1024,
1003 format(string(String), '~1fMb', [Value]).
1004human_stack_size(Size, String) :-
1005 Value is Size / (1024*1024),
1006 format(string(String), '~1fGb', [Value]).
1007
1008overflow_reason(Context, fix) -->
1009 show_non_termination(Context),
1010 !.
1011overflow_reason(Context, enlarge) -->
1012 { Stack = Context.get(stack) },
1013 !,
1014 [ ' In:'-[], nl ],
1015 stack(Stack).
1016overflow_reason(_Context, enlarge) -->
1017 [ ' Insufficient global stack'-[] ].
1018
1019show_non_termination(Context) -->
1020 ( { Stack = Context.get(cycle) }
1021 -> [ ' Probable infinite recursion (cycle):'-[], nl ]
1022 ; { Stack = Context.get(non_terminating) }
1023 -> [ ' Possible non-terminating recursion:'-[], nl ]
1024 ),
1025 stack(Stack).
1026
1027stack([]) --> [].
1028stack([frame(Depth, M:Goal, _)|T]) -->
1029 [ ' [~D] ~q:'-[Depth, M] ],
1030 stack_goal(Goal),
1031 [ nl ],
1032 stack(T).
1033
1034stack_goal(Goal) -->
1035 { compound(Goal),
1036 !,
1037 compound_name_arity(Goal, Name, Arity)
1038 },
1039 [ '~q('-[Name] ],
1040 stack_goal_args(1, Arity, Goal),
1041 [ ')'-[] ].
1042stack_goal(Goal) -->
1043 [ '~q'-[Goal] ].
1044
1045stack_goal_args(I, Arity, Goal) -->
1046 { I =< Arity,
1047 !,
1048 arg(I, Goal, A),
1049 I2 is I + 1
1050 },
1051 stack_goal_arg(A),
1052 ( { I2 =< Arity }
1053 -> [ ', '-[] ],
1054 stack_goal_args(I2, Arity, Goal)
1055 ; []
1056 ).
1057stack_goal_args(_, _, _) -->
1058 [].
1059
1060stack_goal_arg(A) -->
1061 { nonvar(A),
1062 A = [Len|T],
1063 !
1064 },
1065 ( {Len == cyclic_term}
1066 -> [ '[cyclic list]'-[] ]
1067 ; {T == []}
1068 -> [ '[length:~D]'-[Len] ]
1069 ; [ '[length:~D|~p]'-[Len, T] ]
1070 ).
1071stack_goal_arg(A) -->
1072 { nonvar(A),
1073 A = _/_,
1074 !
1075 },
1076 [ '<compound ~p>'-[A] ].
1077stack_goal_arg(A) -->
1078 [ '~p'-[A] ].
1079
1080resolve_overflow(fix) -->
1081 [].
1082resolve_overflow(enlarge) -->
1083 { current_prolog_flag(stack_limit, LimitBytes),
1084 NewLimit is LimitBytes * 2
1085 },
1086 [ nl,
1087 'Use the --stack_limit=size[KMG] command line option or'-[], nl,
1088 '?- set_prolog_flag(stack_limit, ~I). to double the limit.'-[NewLimit]
1089 ].
1090
1095
1096out_of_c_stack -->
1097 { statistics(c_stack, Limit), Limit > 0 },
1098 !,
1099 [ 'C-stack limit (~D bytes) exceeded.'-[Limit], nl ],
1100 resolve_c_stack_overflow(Limit).
1101out_of_c_stack -->
1102 { statistics(c_stack, Limit), Limit > 0 },
1103 [ 'C-stack limit exceeded.'-[Limit], nl ],
1104 resolve_c_stack_overflow(Limit).
1105
1106resolve_c_stack_overflow(_Limit) -->
1107 { thread_self(main) },
1108 [ 'Use the shell command ' ], code('~w', 'ulimit -s size'),
1109 [ ' to enlarge the limit.' ].
1110resolve_c_stack_overflow(_Limit) -->
1111 [ 'Use the ' ], code('~w', 'c_stack(KBytes)'),
1112 [ ' option of '], code(thread_create/3), [' to enlarge the limit.' ].
1113
1114
1115 1118
1119prolog_message(make(reload(Files))) -->
1120 { length(Files, N)
1121 },
1122 [ 'Make: reloading ~D files'-[N] ].
1123prolog_message(make(done(_Files))) -->
1124 [ 'Make: finished' ].
1125prolog_message(make(library_index(Dir))) -->
1126 [ 'Updating index for library ~w'-[Dir] ].
1127prolog_message(autoload(Pred, File)) -->
1128 thread_context,
1129 [ 'autoloading ~p from ~w'-[Pred, File] ].
1130prolog_message(autoload(read_index(Dir))) -->
1131 [ 'Loading autoload index for ~w'-[Dir] ].
1132prolog_message(autoload(disabled(Loaded))) -->
1133 [ 'Disabled autoloading (loaded ~D files)'-[Loaded] ].
1134prolog_message(autoload(already_defined(PI, From))) -->
1135 code(PI),
1136 ( { '$pi_head'(PI, Head),
1137 predicate_property(Head, built_in)
1138 }
1139 -> [' is a built-in predicate']
1140 ; [ ' is already imported from module ' ],
1141 code(From)
1142 ).
1143
1144swi_message(autoload(Msg)) -->
1145 [ nl, ' ' ],
1146 autoload_message(Msg).
1147
1148autoload_message(not_exported(PI, Spec, _FullFile, _Exports)) -->
1149 [ ansi(code, '~w', [Spec]),
1150 ' does not export ',
1151 ansi(code, '~p', [PI])
1152 ].
1153autoload_message(no_file(Spec)) -->
1154 [ ansi(code, '~p', [Spec]), ': No such file' ].
1155
1156
1157 1160
1163
1164prolog_message(compiler_warnings(Clause, Warnings0)) -->
1165 { print_goal_options(DefOptions),
1166 ( prolog_load_context(variable_names, VarNames)
1167 -> warnings_with_named_vars(Warnings0, VarNames, Warnings),
1168 Options = [variable_names(VarNames)|DefOptions]
1169 ; Options = DefOptions,
1170 Warnings = Warnings0
1171 )
1172 },
1173 compiler_warnings(Warnings, Clause, Options).
1174
1175warnings_with_named_vars([], _, []).
1176warnings_with_named_vars([H|T0], VarNames, [H|T]) :-
1177 term_variables(H, Vars),
1178 '$member'(V1, Vars),
1179 '$member'(_=V2, VarNames),
1180 V1 == V2,
1181 !,
1182 warnings_with_named_vars(T0, VarNames, T).
1183warnings_with_named_vars([_|T0], VarNames, T) :-
1184 warnings_with_named_vars(T0, VarNames, T).
1185
1186
1187compiler_warnings([], _, _) --> [].
1188compiler_warnings([H|T], Clause, Options) -->
1189 ( compiler_warning(H, Clause, Options)
1190 -> []
1191 ; [ 'Unknown compiler warning: ~W'-[H,Options] ]
1192 ),
1193 ( {T==[]}
1194 -> []
1195 ; [nl]
1196 ),
1197 compiler_warnings(T, Clause, Options).
1198
1199compiler_warning(eq_vv(A,B), _Clause, Options) -->
1200 ( { A == B }
1201 -> [ 'Test is always true: ~W'-[A==B, Options] ]
1202 ; [ 'Test is always false: ~W'-[A==B, Options] ]
1203 ).
1204compiler_warning(eq_singleton(A,B), _Clause, Options) -->
1205 [ 'Test is always false: ~W'-[A==B, Options] ].
1206compiler_warning(neq_vv(A,B), _Clause, Options) -->
1207 ( { A \== B }
1208 -> [ 'Test is always true: ~W'-[A\==B, Options] ]
1209 ; [ 'Test is always false: ~W'-[A\==B, Options] ]
1210 ).
1211compiler_warning(neq_singleton(A,B), _Clause, Options) -->
1212 [ 'Test is always true: ~W'-[A\==B, Options] ].
1213compiler_warning(unify_singleton(A,B), _Clause, Options) -->
1214 [ 'Unified variable is not used: ~W'-[A=B, Options] ].
1215compiler_warning(always(Bool, Pred, Arg), _Clause, Options) -->
1216 { Goal =.. [Pred,Arg] },
1217 [ 'Test is always ~w: ~W'-[Bool, Goal, Options] ].
1218compiler_warning(unbalanced_var(V), _Clause, Options) -->
1219 [ 'Variable not introduced in all branches: ~W'-[V, Options] ].
1220compiler_warning(branch_singleton(V), _Clause, Options) -->
1221 [ 'Singleton variable in branch: ~W'-[V, Options] ].
1222compiler_warning(negation_singleton(V), _Clause, Options) -->
1223 [ 'Singleton variable in \\+: ~W'-[V, Options] ].
1224compiler_warning(multiton(V), _Clause, Options) -->
1225 [ 'Singleton-marked variable appears more than once: ~W'-[V, Options] ].
1226
1227print_goal_options(
1228 [ quoted(true),
1229 portray(true)
1230 ]).
1231
1232
1233 1236
1237prolog_message(version) -->
1238 { current_prolog_flag(version_git, Version) },
1239 !,
1240 [ '~w'-[Version] ].
1241prolog_message(version) -->
1242 { current_prolog_flag(version_data, swi(Major,Minor,Patch,Options))
1243 },
1244 ( { memberchk(tag(Tag), Options) }
1245 -> [ '~w.~w.~w-~w'-[Major, Minor, Patch, Tag] ]
1246 ; [ '~w.~w.~w'-[Major, Minor, Patch] ]
1247 ).
1248prolog_message(address_bits) -->
1249 { current_prolog_flag(address_bits, Bits)
1250 },
1251 !,
1252 [ '~d bits, '-[Bits] ].
1253prolog_message(threads) -->
1254 { current_prolog_flag(threads, true)
1255 },
1256 !,
1257 [ 'threaded, ' ].
1258prolog_message(threads) -->
1259 [].
1260prolog_message(copyright) -->
1261 [ 'SWI-Prolog comes with ABSOLUTELY NO WARRANTY. This is free software.', nl,
1262 'Please run ?- license. for legal details.'
1263 ].
1264prolog_message(documentaton) -->
1265 [ 'For online help and background, visit https://www.swi-prolog.org', nl,
1266 'For built-in help, use ?- help(Topic). or ?- apropos(Word).'
1267 ].
1268prolog_message(about) -->
1269 [ 'SWI-Prolog version (' ],
1270 prolog_message(threads),
1271 prolog_message(address_bits),
1272 ['version ' ],
1273 prolog_message(version),
1274 [ ')', nl ],
1275 prolog_message(copyright).
1276prolog_message(halt) -->
1277 [ 'halt' ].
1278prolog_message(break(begin, Level)) -->
1279 [ 'Break level ~d'-[Level] ].
1280prolog_message(break(end, Level)) -->
1281 [ 'Exit break level ~d'-[Level] ].
1282prolog_message(var_query(_)) -->
1283 [ '... 1,000,000 ............ 10,000,000 years later', nl, nl,
1284 '~t~8|>> 42 << (last release gives the question)'
1285 ].
1286prolog_message(close_on_abort(Stream)) -->
1287 [ 'Abort: closed stream ~p'-[Stream] ].
1288prolog_message(cancel_halt(Reason)) -->
1289 [ 'Halt cancelled: ~p'-[Reason] ].
1290prolog_message(on_error(halt(Status))) -->
1291 { statistics(errors, Errors),
1292 statistics(warnings, Warnings)
1293 },
1294 [ 'Halting with status ~w due to ~D errors and ~D warnings'-
1295 [Status, Errors, Warnings] ].
1296
1297prolog_message(query(QueryResult)) -->
1298 query_result(QueryResult).
1299
1300query_result(no) --> 1301 [ ansi(truth(false), 'false.', []) ],
1302 extra_line.
1303query_result(yes(true, [])) --> 1304 !,
1305 [ ansi(truth(true), 'true.', []) ],
1306 extra_line.
1307query_result(yes(Delays, Residuals)) -->
1308 result([], Delays, Residuals),
1309 extra_line.
1310query_result(done) --> 1311 extra_line.
1312query_result(yes(Bindings, Delays, Residuals)) -->
1313 result(Bindings, Delays, Residuals),
1314 prompt(yes, Bindings, Delays, Residuals).
1315query_result(more(Bindings, Delays, Residuals)) -->
1316 result(Bindings, Delays, Residuals),
1317 prompt(more, Bindings, Delays, Residuals).
1318query_result(help) -->
1319 [ ansi(bold, ' Possible actions:', []), nl,
1320 ' ; (n,r,space,TAB): redo | t: trace&redo'-[], nl,
1321 ' *: show choicepoint | c (a,RET): stop'-[], nl,
1322 ' w: write | p: print'-[], nl,
1323 ' +: max_depth*10 | -: max_depth//10'-[], nl,
1324 ' b: break | h (?): help'-[],
1325 nl, nl
1326 ].
1327query_result(action) -->
1328 [ 'Action? '-[], flush ].
1329query_result(confirm) -->
1330 [ 'Please answer \'y\' or \'n\'? '-[], flush ].
1331query_result(eof) -->
1332 [ nl ].
1333query_result(toplevel_open_line) -->
1334 [].
1335
1336prompt(Answer, [], true, []-[]) -->
1337 !,
1338 prompt(Answer, empty).
1339prompt(Answer, _, _, _) -->
1340 !,
1341 prompt(Answer, non_empty).
1342
1343prompt(yes, empty) -->
1344 !,
1345 [ ansi(truth(true), 'true.', []) ],
1346 extra_line.
1347prompt(yes, _) -->
1348 !,
1349 [ full_stop ],
1350 extra_line.
1351prompt(more, empty) -->
1352 !,
1353 [ ansi(truth(true), 'true ', []), flush ].
1354prompt(more, _) -->
1355 !,
1356 [ ' '-[], flush ].
1357
1358result(Bindings, Delays, Residuals) -->
1359 { current_prolog_flag(answer_write_options, Options0),
1360 Options = [partial(true)|Options0],
1361 GOptions = [priority(999)|Options0]
1362 },
1363 wfs_residual_program(Delays, GOptions),
1364 bindings(Bindings, [priority(699)|Options]),
1365 ( {Residuals == []-[]}
1366 -> bind_delays_sep(Bindings, Delays),
1367 delays(Delays, GOptions)
1368 ; bind_res_sep(Bindings, Residuals),
1369 residuals(Residuals, GOptions),
1370 ( {Delays == true}
1371 -> []
1372 ; [','-[], nl],
1373 delays(Delays, GOptions)
1374 )
1375 ).
1376
1377bindings([], _) -->
1378 [].
1379bindings([binding(Names,Skel,Subst)|T], Options) -->
1380 { '$last'(Names, Name) },
1381 var_names(Names), value(Name, Skel, Subst, Options),
1382 ( { T \== [] }
1383 -> [ ','-[], nl ],
1384 bindings(T, Options)
1385 ; []
1386 ).
1387
1388var_names([Name]) -->
1389 !,
1390 [ '~w = '-[Name] ].
1391var_names([Name1,Name2|T]) -->
1392 !,
1393 [ '~w = ~w, '-[Name1, Name2] ],
1394 var_names([Name2|T]).
1395
1396
1397value(Name, Skel, Subst, Options) -->
1398 ( { var(Skel), Subst = [Skel=S] }
1399 -> { Skel = '$VAR'(Name) },
1400 [ '~W'-[S, Options] ]
1401 ; [ '~W'-[Skel, Options] ],
1402 substitution(Subst, Options)
1403 ).
1404
1405substitution([], _) --> !.
1406substitution([N=V|T], Options) -->
1407 [ ', ', ansi(comment, '% where', []), nl,
1408 ' ~w = ~W'-[N,V,Options] ],
1409 substitutions(T, Options).
1410
1411substitutions([], _) --> [].
1412substitutions([N=V|T], Options) -->
1413 [ ','-[], nl, ' ~w = ~W'-[N,V,Options] ],
1414 substitutions(T, Options).
1415
1416
1417residuals(Normal-Hidden, Options) -->
1418 residuals1(Normal, Options),
1419 bind_res_sep(Normal, Hidden),
1420 ( {Hidden == []}
1421 -> []
1422 ; [ansi(comment, '% with pending residual goals', []), nl]
1423 ),
1424 residuals1(Hidden, Options).
1425
1426residuals1([], _) -->
1427 [].
1428residuals1([G|Gs], Options) -->
1429 ( { Gs \== [] }
1430 -> [ '~W,'-[G, Options], nl ],
1431 residuals1(Gs, Options)
1432 ; [ '~W'-[G, Options] ]
1433 ).
1434
1435wfs_residual_program(true, _Options) -->
1436 !.
1437wfs_residual_program(Goal, _Options) -->
1438 { current_prolog_flag(toplevel_list_wfs_residual_program, true),
1439 '$current_typein_module'(TypeIn),
1440 ( current_predicate(delays_residual_program/2)
1441 -> true
1442 ; use_module(library(wfs), [delays_residual_program/2])
1443 ),
1444 delays_residual_program(TypeIn:Goal, TypeIn:Program),
1445 Program \== []
1446 },
1447 !,
1448 [ ansi(comment, '% WFS residual program', []), nl ],
1449 [ ansi(wfs(residual_program), '~@', ['$messages':list_clauses(Program)]) ].
1450wfs_residual_program(_, _) --> [].
1451
1452delays(true, _Options) -->
1453 !.
1454delays(Goal, Options) -->
1455 { current_prolog_flag(toplevel_list_wfs_residual_program, true)
1456 },
1457 !,
1458 [ ansi(truth(undefined), '~W', [Goal, Options]) ].
1459delays(_, _Options) -->
1460 [ ansi(truth(undefined), undefined, []) ].
1461
1462:- public list_clauses/1. 1463
1464list_clauses([]).
1465list_clauses([H|T]) :-
1466 ( system_undefined(H)
1467 -> true
1468 ; portray_clause(user_output, H, [indent(4)])
1469 ),
1470 list_clauses(T).
1471
1472system_undefined((undefined :- tnot(undefined))).
1473system_undefined((answer_count_restraint :- tnot(answer_count_restraint))).
1474system_undefined((radial_restraint :- tnot(radial_restraint))).
1475
1476bind_res_sep(_, []) --> !.
1477bind_res_sep(_, []-[]) --> !.
1478bind_res_sep([], _) --> !.
1479bind_res_sep(_, _) --> [','-[], nl].
1480
1481bind_delays_sep([], _) --> !.
1482bind_delays_sep(_, true) --> !.
1483bind_delays_sep(_, _) --> [','-[], nl].
1484
-->
1486 { current_prolog_flag(toplevel_extra_white_line, true) },
1487 !,
1488 ['~N'-[]].
1489extra_line -->
1490 [].
1491
1492prolog_message(if_tty(Message)) -->
1493 ( {current_prolog_flag(tty_control, true)}
1494 -> [ at_same_line | Message ]
1495 ; []
1496 ).
1497prolog_message(halt(Reason)) -->
1498 [ '~w: halt'-[Reason] ].
1499prolog_message(no_action(Char)) -->
1500 [ 'Unknown action: ~c (h for help)'-[Char], nl ].
1501
1502prolog_message(history(help(Show, Help))) -->
1503 [ 'History Commands:', nl,
1504 ' !!. Repeat last query', nl,
1505 ' !nr. Repeat query numbered <nr>', nl,
1506 ' !str. Repeat last query starting with <str>', nl,
1507 ' !?str. Repeat last query holding <str>', nl,
1508 ' ^old^new. Substitute <old> into <new> of last query', nl,
1509 ' !nr^old^new. Substitute in query numbered <nr>', nl,
1510 ' !str^old^new. Substitute in query starting with <str>', nl,
1511 ' !?str^old^new. Substitute in query holding <str>', nl,
1512 ' ~w.~21|Show history list'-[Show], nl,
1513 ' ~w.~21|Show this list'-[Help], nl, nl
1514 ].
1515prolog_message(history(no_event)) -->
1516 [ '! No such event' ].
1517prolog_message(history(bad_substitution)) -->
1518 [ '! Bad substitution' ].
1519prolog_message(history(expanded(Event))) -->
1520 [ '~w.'-[Event] ].
1521prolog_message(history(history(Events))) -->
1522 history_events(Events).
1523
1524history_events([]) -->
1525 [].
1526history_events([Nr/Event|T]) -->
1527 [ '~t~w ~8|~W~W'-[ Nr,
1528 Event, [partial(true)],
1529 '.', [partial(true)]
1530 ],
1531 nl
1532 ],
1533 history_events(T).
1534
1535
1540
1541user_version_messages([]) --> [].
1542user_version_messages([H|T]) -->
1543 user_version_message(H),
1544 user_version_messages(T).
1545
1547
1548user_version_message(Term) -->
1549 translate_message(Term), !, [nl].
1550user_version_message(Atom) -->
1551 [ '~w'-[Atom], nl ].
1552
1553
1554 1557
1558prolog_message(spy(Head)) -->
1559 { goal_to_predicate_indicator(Head, Pred)
1560 },
1561 [ 'Spy point on ~p'-[Pred] ].
1562prolog_message(nospy(Head)) -->
1563 { goal_to_predicate_indicator(Head, Pred)
1564 },
1565 [ 'Spy point removed from ~p'-[Pred] ].
1566prolog_message(trace_mode(OnOff)) -->
1567 [ 'Trace mode switched to ~w'-[OnOff] ].
1568prolog_message(debug_mode(OnOff)) -->
1569 [ 'Debug mode switched to ~w'-[OnOff] ].
1570prolog_message(debugging(OnOff)) -->
1571 [ 'Debug mode is ~w'-[OnOff] ].
1572prolog_message(spying([])) -->
1573 !,
1574 [ 'No spy points' ].
1575prolog_message(spying(Heads)) -->
1576 [ 'Spy points (see spy/1) on:', nl ],
1577 predicate_list(Heads).
1578prolog_message(trace(Head, [])) -->
1579 !,
1580 [ ' ' ], goal_predicate(Head), [ ' Not tracing'-[], nl].
1581prolog_message(trace(Head, Ports)) -->
1582 { '$member'(Port, Ports), compound(Port),
1583 !,
1584 numbervars(Head+Ports, 0, _, [singletons(true)])
1585 },
1586 [ ' ~p: ~p'-[Head,Ports] ].
1587prolog_message(trace(Head, Ports)) -->
1588 [ ' ' ], goal_predicate(Head), [ ': ~w'-[Ports], nl].
1589prolog_message(tracing([])) -->
1590 !,
1591 [ 'No traced predicates (see trace/1,2)' ].
1592prolog_message(tracing(Heads)) -->
1593 [ 'Trace points (see trace/1,2) on:', nl ],
1594 tracing_list(Heads).
1595
1596goal_predicate(Head) -->
1597 { predicate_property(Head, file(File)),
1598 predicate_property(Head, line_count(Line)),
1599 goal_to_predicate_indicator(Head, PI),
1600 term_string(PI, PIS, [quoted(true)])
1601 },
1602 [ url(File:Line, PIS) ].
1603goal_predicate(Head) -->
1604 { goal_to_predicate_indicator(Head, PI)
1605 },
1606 [ '~p'-[PI] ].
1607
1608
1609predicate_list([]) --> 1610 [].
1611predicate_list([H|T]) -->
1612 [ ' ' ], goal_predicate(H), [nl],
1613 predicate_list(T).
1614
1615tracing_list([]) -->
1616 [].
1617tracing_list([trace(Head, Ports)|T]) -->
1618 translate_message(trace(Head, Ports)),
1619 tracing_list(T).
1620
1621prolog_message(frame(Frame, backtrace, _PC)) -->
1622 !,
1623 { prolog_frame_attribute(Frame, level, Level)
1624 },
1625 [ ansi(frame(level), '~t[~D] ~10|', [Level]) ],
1626 frame_context(Frame),
1627 frame_goal(Frame).
1628prolog_message(frame(Frame, choice, PC)) -->
1629 !,
1630 prolog_message(frame(Frame, backtrace, PC)).
1631prolog_message(frame(_, cut_call, _)) --> !, [].
1632prolog_message(frame(Goal, trace(Port))) -->
1633 !,
1634 thread_context,
1635 [ ' T ' ],
1636 port(Port),
1637 goal(Goal).
1638prolog_message(frame(Goal, trace(Port, Id))) -->
1639 !,
1640 thread_context,
1641 [ ' T ' ],
1642 port(Port, Id),
1643 goal(Goal).
1644prolog_message(frame(Frame, Port, _PC)) -->
1645 frame_flags(Frame),
1646 port(Port),
1647 frame_level(Frame),
1648 frame_context(Frame),
1649 frame_depth_limit(Port, Frame),
1650 frame_goal(Frame),
1651 [ flush ].
1652
1653frame_goal(Frame) -->
1654 { prolog_frame_attribute(Frame, goal, Goal)
1655 },
1656 goal(Goal).
1657
1658goal(Goal0) -->
1659 { clean_goal(Goal0, Goal),
1660 current_prolog_flag(debugger_write_options, Options)
1661 },
1662 [ '~W'-[Goal, Options] ].
1663
1664frame_level(Frame) -->
1665 { prolog_frame_attribute(Frame, level, Level)
1666 },
1667 [ '(~D) '-[Level] ].
1668
1669frame_context(Frame) -->
1670 ( { current_prolog_flag(debugger_show_context, true),
1671 prolog_frame_attribute(Frame, context_module, Context)
1672 }
1673 -> [ '[~w] '-[Context] ]
1674 ; []
1675 ).
1676
1677frame_depth_limit(fail, Frame) -->
1678 { prolog_frame_attribute(Frame, depth_limit_exceeded, true)
1679 },
1680 !,
1681 [ '[depth-limit exceeded] ' ].
1682frame_depth_limit(_, _) -->
1683 [].
1684
1685frame_flags(Frame) -->
1686 { prolog_frame_attribute(Frame, goal, Goal),
1687 ( predicate_property(Goal, transparent)
1688 -> T = '^'
1689 ; T = ' '
1690 ),
1691 ( predicate_property(Goal, spying)
1692 -> S = '*'
1693 ; S = ' '
1694 )
1695 },
1696 [ '~w~w '-[T, S] ].
1697
1699port(Port, Dict) -->
1700 { _{level:Level, start:Time} :< Dict
1701 },
1702 ( { Port \== call,
1703 get_time(Now),
1704 Passed is (Now - Time)*1000.0
1705 }
1706 -> [ '[~d +~1fms] '-[Level, Passed] ]
1707 ; [ '[~d] '-[Level] ]
1708 ),
1709 port(Port).
1710port(Port, _Id-Level) -->
1711 [ '[~d] '-[Level] ],
1712 port(Port).
1713
1714port(Port) -->
1715 { port_name(Port, Name)
1716 },
1717 !,
1718 [ ansi(port(Port), '~w: ', [Name]) ].
1719
1720port_name(call, 'Call').
1721port_name(exit, 'Exit').
1722port_name(fail, 'Fail').
1723port_name(redo, 'Redo').
1724port_name(unify, 'Unify').
1725port_name(exception, 'Exception').
1726
1727clean_goal(M:Goal, Goal) :-
1728 hidden_module(M),
1729 !.
1730clean_goal(M:Goal, Goal) :-
1731 predicate_property(M:Goal, built_in),
1732 !.
1733clean_goal(Goal, Goal).
1734
1735
1736 1739
1740prolog_message(compatibility(renamed(Old, New))) -->
1741 [ 'The predicate ~p has been renamed to ~p.'-[Old, New], nl,
1742 'Please update your sources for compatibility with future versions.'
1743 ].
1744
1745
1746 1749
1750prolog_message(abnormal_thread_completion(Goal, exception(Ex))) -->
1751 !,
1752 [ 'Thread running "~p" died on exception: '-[Goal] ],
1753 translate_message(Ex).
1754prolog_message(abnormal_thread_completion(Goal, fail)) -->
1755 [ 'Thread running "~p" died due to failure'-[Goal] ].
1756prolog_message(threads_not_died(Running)) -->
1757 [ 'The following threads wouldn\'t die: ~p'-[Running] ].
1758
1759
1760 1763
1764prolog_message(pack(attached(Pack, BaseDir))) -->
1765 [ 'Attached package ~w at ~q'-[Pack, BaseDir] ].
1766prolog_message(pack(duplicate(Entry, OldDir, Dir))) -->
1767 [ 'Package ~w already attached at ~q.'-[Entry,OldDir], nl,
1768 '\tIgnoring version from ~q'- [Dir]
1769 ].
1770prolog_message(pack(no_arch(Entry, Arch))) -->
1771 [ 'Package ~w: no binary for architecture ~w'-[Entry, Arch] ].
1772
1773 1776
1777prolog_message(null_byte_in_path(Component)) -->
1778 [ '0-byte in PATH component: ~p (skipped directory)'-[Component] ].
1779prolog_message(invalid_tmp_dir(Dir, Reason)) -->
1780 [ 'Cannot use ~p as temporary file directory: ~w'-[Dir, Reason] ].
1781prolog_message(ambiguous_stream_pair(Pair)) -->
1782 [ 'Ambiguous operation on stream pair ~p'-[Pair] ].
1783prolog_message(backcomp(init_file_moved(FoundFile))) -->
1784 { absolute_file_name(app_config('init.pl'), InitFile,
1785 [ file_errors(fail)
1786 ])
1787 },
1788 [ 'The location of the config file has moved'-[], nl,
1789 ' from "~w"'-[FoundFile], nl,
1790 ' to "~w"'-[InitFile], nl,
1791 ' See https://www.swi-prolog.org/modified/config-files.html'-[]
1792 ].
1793prolog_message(not_accessed_flags(List)) -->
1794 [ 'The following Prolog flags have been set but not used:', nl ],
1795 flags(List).
1796prolog_message(prolog_flag_invalid_preset(Flag, Preset, _Type, New)) -->
1797 [ 'Prolog flag ', ansi(code, '~q', Flag), ' has been (re-)created with a type that is \c
1798 incompatible with its value.', nl,
1799 'Value updated from ', ansi(code, '~p', [Preset]), ' to default (',
1800 ansi(code, '~p', [New]), ')'
1801 ].
1802
1803
1804flags([H|T]) -->
1805 [' ', ansi(code, '~q', [H])],
1806 ( {T == []}
1807 -> []
1808 ; [nl],
1809 flags(T)
1810 ).
1811
1812
1813 1816
1817deprecated(set_prolog_stack(_Stack,limit)) -->
1818 [ 'set_prolog_stack/2: limit(Size) sets the combined limit.'-[], nl,
1819 'See https://www.swi-prolog.org/changes/stack-limit.html'
1820 ].
1821deprecated(autoload(TargetModule, File, _M:PI, expansion)) -->
1822 !,
1823 [ 'Auto-loading ', ansi(code, '~p', [PI]), ' from ' ],
1824 load_file(File), [ ' into ' ],
1825 target_module(TargetModule),
1826 [ ' is deprecated due to term- or goal-expansion' ].
1827
1828load_file(File) -->
1829 { file_base_name(File, Base),
1830 absolute_file_name(library(Base), File, [access(read), file_errors(fail)]),
1831 file_name_extension(Clean, pl, Base)
1832 },
1833 !,
1834 [ ansi(code, '~p', [library(Clean)]) ].
1835load_file(File) -->
1836 [ url(File) ].
1837
1838target_module(Module) -->
1839 { module_property(Module, file(File)) },
1840 !,
1841 load_file(File).
1842target_module(Module) -->
1843 [ 'module ', ansi(code, '~p', [Module]) ].
1844
1845
1846
1847 1850
1851tripwire_message(max_integer_size, Bytes) -->
1852 !,
1853 [ 'Trapped tripwire max_integer_size: big integers and \c
1854 rationals are limited to ~D bytes'-[Bytes] ].
1855tripwire_message(Wire, Context) -->
1856 [ 'Trapped tripwire ~w for '-[Wire] ],
1857 tripwire_context(Wire, Context).
1858
1859tripwire_context(_, ATrie) -->
1860 { '$is_answer_trie'(ATrie, _),
1861 !,
1862 '$tabling':atrie_goal(ATrie, QGoal),
1863 user_predicate_indicator(QGoal, Goal)
1864 },
1865 [ '~p'-[Goal] ].
1866tripwire_context(_, Ctx) -->
1867 [ '~p'-[Ctx] ].
1868
1869
1870 1873
1874:- create_prolog_flag(message_language, default, []). 1875
1880
1881message_lang(Lang) :-
1882 current_message_lang(Lang0),
1883 ( Lang0 == en
1884 -> Lang = en
1885 ; sub_atom(Lang0, 0, _, _, en_)
1886 -> longest_id(Lang0, Lang)
1887 ; ( longest_id(Lang0, Lang)
1888 ; Lang = en
1889 )
1890 ).
1891
1892longest_id(Lang, Id) :-
1893 split_string(Lang, "_-", "", [H|Components]),
1894 longest_prefix(Components, Taken),
1895 atomic_list_concat([H|Taken], '_', Id).
1896
1897longest_prefix([H|T0], [H|T]) :-
1898 longest_prefix(T0, T).
1899longest_prefix(_, []).
1900
1904
1905current_message_lang(Lang) :-
1906 ( current_prolog_flag(message_language, Lang0),
1907 Lang0 \== default
1908 -> Lang = Lang0
1909 ; os_user_lang(Lang0)
1910 -> clean_encoding(Lang0, Lang1),
1911 set_prolog_flag(message_language, Lang1),
1912 Lang = Lang1
1913 ; Lang = en
1914 ).
1915
1916os_user_lang(Lang) :-
1917 current_prolog_flag(windows, true),
1918 win_get_user_preferred_ui_languages(name, [Lang|_]).
1919os_user_lang(Lang) :-
1920 catch(setlocale(messages, _, ''), _, fail),
1921 setlocale(messages, Lang, Lang).
1922os_user_lang(Lang) :-
1923 getenv('LANG', Lang).
1924
1925
1926clean_encoding(Lang0, Lang) :-
1927 ( sub_atom(Lang0, A, _, _, '.')
1928 -> sub_atom(Lang0, 0, A, _, Lang)
1929 ; Lang = Lang0
1930 ).
1931
1932 1935
1936code(Term) -->
1937 code('~p', Term).
1938
1939code(Format, Term) -->
1940 [ ansi(code, Format, [Term]) ].
1941
1942
1943 1946
1947:- public default_theme/2. 1948
1949default_theme(var, [fg(red)]).
1950default_theme(code, [fg(blue)]).
1951default_theme(comment, [fg(green)]).
1952default_theme(warning, [fg(red)]).
1953default_theme(error, [bold, fg(red)]).
1954default_theme(truth(false), [bold, fg(red)]).
1955default_theme(truth(true), [bold]).
1956default_theme(truth(undefined), [bold, fg(cyan)]).
1957default_theme(wfs(residual_program), [fg(cyan)]).
1958default_theme(frame(level), [bold]).
1959default_theme(port(call), [bold, fg(green)]).
1960default_theme(port(exit), [bold, fg(green)]).
1961default_theme(port(fail), [bold, fg(red)]).
1962default_theme(port(redo), [bold, fg(yellow)]).
1963default_theme(port(unify), [bold, fg(blue)]).
1964default_theme(port(exception), [bold, fg(magenta)]).
1965default_theme(message(informational), [fg(green)]).
1966default_theme(message(information), [fg(green)]).
1967default_theme(message(debug(_)), [fg(blue)]).
1968default_theme(message(Level), Attrs) :-
1969 nonvar(Level),
1970 default_theme(Level, Attrs).
1971
1972
1973 1976
1977:- multifile
1978 user:message_hook/3,
1979 prolog:message_prefix_hook/2. 1980:- dynamic
1981 user:message_hook/3,
1982 prolog:message_prefix_hook/2. 1983:- thread_local
1984 user:thread_message_hook/3. 1985:- '$hide'((push_msg/1,pop_msg/0)). 1986:- '$notransact'((user:message_hook/3,
1987 prolog:message_prefix_hook/2,
1988 user:thread_message_hook/3)). 1989
1994
1995print_message(Level, _Term) :-
1996 msg_property(Level, stream(S)),
1997 stream_property(S, error(true)),
1998 !.
1999print_message(Level, Term) :-
2000 setup_call_cleanup(
2001 push_msg(Term, Stack),
2002 ignore(print_message_guarded(Level, Term)),
2003 pop_msg(Stack)),
2004 !.
2005print_message(Level, Term) :-
2006 ( Level \== silent
2007 -> format(user_error, 'Recursive ~w message: ~q~n', [Level, Term]),
2008 backtrace(20)
2009 ; true
2010 ).
2011
2012push_msg(Term, Messages) :-
2013 nb_current('$inprint_message', Messages),
2014 !,
2015 \+ ( '$member'(Msg, Messages),
2016 Msg =@= Term
2017 ),
2018 Stack = [Term|Messages],
2019 b_setval('$inprint_message', Stack).
2020push_msg(Term, []) :-
2021 b_setval('$inprint_message', [Term]).
2022
2023pop_msg(Stack) :-
2024 nb_delete('$inprint_message'), 2025 b_setval('$inprint_message', Stack).
2026
2027print_message_guarded(Level, Term) :-
2028 ( must_print(Level, Term)
2029 -> ( translate_message(Term, Lines, [])
2030 -> ( nonvar(Term),
2031 ( notrace(user:thread_message_hook(Term, Level, Lines))
2032 -> true
2033 ; notrace(user:message_hook(Term, Level, Lines))
2034 )
2035 -> true
2036 ; '$inc_message_count'(Level),
2037 print_system_message(Term, Level, Lines),
2038 maybe_halt_on_error(Level)
2039 )
2040 )
2041 ; true
2042 ).
2043
2044maybe_halt_on_error(error) :-
2045 current_prolog_flag(on_error, halt),
2046 !,
2047 halt(1).
2048maybe_halt_on_error(warning) :-
2049 current_prolog_flag(on_warning, halt),
2050 !,
2051 halt(1).
2052maybe_halt_on_error(_).
2053
2054
2061
2062print_system_message(_, silent, _) :- !.
2063print_system_message(_, informational, _) :-
2064 current_prolog_flag(verbose, silent),
2065 !.
2066print_system_message(_, banner, _) :-
2067 current_prolog_flag(verbose, silent),
2068 !.
2069print_system_message(_, _, []) :- !.
2070print_system_message(Term, Kind, Lines) :-
2071 catch(flush_output(user_output), _, true), 2072 source_location(File, Line),
2073 Term \= error(syntax_error(_), _),
2074 msg_property(Kind, location_prefix(File:Line, LocPrefix, LinePrefix)),
2075 !,
2076 to_list(LocPrefix, LocPrefixL),
2077 insert_prefix(Lines, LinePrefix, Ctx, PrefixLines),
2078 '$append'([ [begin(Kind, Ctx)],
2079 LocPrefixL,
2080 [nl],
2081 PrefixLines,
2082 [end(Ctx)]
2083 ],
2084 AllLines),
2085 msg_property(Kind, stream(Stream)),
2086 ignore(stream_property(Stream, position(Pos))),
2087 print_message_lines(Stream, AllLines),
2088 ( \+ stream_property(Stream, position(Pos)),
2089 msg_property(Kind, wait(Wait)),
2090 Wait > 0
2091 -> sleep(Wait)
2092 ; true
2093 ).
2094print_system_message(_, Kind, Lines) :-
2095 msg_property(Kind, stream(Stream)),
2096 print_message_lines(Stream, kind(Kind), Lines).
2097
2098to_list(ListIn, List) :-
2099 is_list(ListIn),
2100 !,
2101 List = ListIn.
2102to_list(NonList, [NonList]).
2103
2104:- multifile
2105 user:message_property/2. 2106
2107msg_property(Kind, Property) :-
2108 notrace(user:message_property(Kind, Property)),
2109 !.
2110msg_property(Kind, prefix(Prefix)) :-
2111 msg_prefix(Kind, Prefix),
2112 !.
2113msg_property(_, prefix('~N')) :- !.
2114msg_property(query, stream(user_output)) :- !.
2115msg_property(_, stream(user_error)) :- !.
2116msg_property(error, tag('ERROR')).
2117msg_property(warning, tag('Warning')).
2118msg_property(Level,
2119 location_prefix(File:Line,
2120 ['~N~w: '-[Tag], url(File:Line), ':'],
2121 '~N~w: '-[Tag])) :-
2122 include_msg_location(Level),
2123 msg_property(Level, tag(Tag)).
2124msg_property(error, wait(0.1)) :- !.
2125
2126include_msg_location(warning).
2127include_msg_location(error).
2128
2129msg_prefix(debug(_), Prefix) :-
2130 msg_context('~N% ', Prefix).
2131msg_prefix(Level, Prefix) :-
2132 msg_property(Level, tag(Tag)),
2133 atomics_to_string(['~N', Tag, ': '], Prefix0),
2134 msg_context(Prefix0, Prefix).
2135msg_prefix(informational, '~N% ').
2136msg_prefix(information, '~N% ').
2137
2149
2150msg_context(Prefix0, Prefix) :-
2151 current_prolog_flag(message_context, Context),
2152 is_list(Context),
2153 !,
2154 add_message_context(Context, Prefix0, Prefix).
2155msg_context(Prefix, Prefix).
2156
2157add_message_context([], Prefix, Prefix).
2158add_message_context([H|T], Prefix0, Prefix) :-
2159 ( add_message_context1(H, Prefix0, Prefix1)
2160 -> true
2161 ; Prefix1 = Prefix0
2162 ),
2163 add_message_context(T, Prefix1, Prefix).
2164
2165add_message_context1(Context, Prefix0, Prefix) :-
2166 prolog:message_prefix_hook(Context, Extra),
2167 atomics_to_string([Prefix0, Extra, ' '], Prefix).
2168add_message_context1(time, Prefix0, Prefix) :-
2169 get_time(Now),
2170 format_time(string(S), '%T.%3f ', Now),
2171 string_concat(Prefix0, S, Prefix).
2172add_message_context1(time(Format), Prefix0, Prefix) :-
2173 get_time(Now),
2174 format_time(string(S), Format, Now),
2175 atomics_to_string([Prefix0, S, ' '], Prefix).
2176add_message_context1(thread, Prefix0, Prefix) :-
2177 thread_self(Id0),
2178 Id0 \== main,
2179 !,
2180 ( atom(Id0)
2181 -> Id = Id0
2182 ; thread_property(Id0, id(Id))
2183 ),
2184 format(string(Prefix), '~w[Thread ~w] ', [Prefix0, Id]).
2185
2190
2191print_message_lines(Stream, kind(Kind), Lines) :-
2192 !,
2193 msg_property(Kind, prefix(Prefix)),
2194 insert_prefix(Lines, Prefix, Ctx, PrefixLines),
2195 '$append'([ begin(Kind, Ctx)
2196 | PrefixLines
2197 ],
2198 [ end(Ctx)
2199 ],
2200 AllLines),
2201 print_message_lines(Stream, AllLines).
2202print_message_lines(Stream, Prefix, Lines) :-
2203 insert_prefix(Lines, Prefix, _, PrefixLines),
2204 print_message_lines(Stream, PrefixLines).
2205
2207
2208insert_prefix([at_same_line|Lines0], Prefix, Ctx, Lines) :-
2209 !,
2210 prefix_nl(Lines0, Prefix, Ctx, Lines).
2211insert_prefix(Lines0, Prefix, Ctx, [prefix(Prefix)|Lines]) :-
2212 prefix_nl(Lines0, Prefix, Ctx, Lines).
2213
2214prefix_nl([], _, _, [nl]).
2215prefix_nl([nl], _, _, [nl]) :- !.
2216prefix_nl([flush], _, _, [flush]) :- !.
2217prefix_nl([nl|T0], Prefix, Ctx, [nl, prefix(Prefix)|T]) :-
2218 !,
2219 prefix_nl(T0, Prefix, Ctx, T).
2220prefix_nl([ansi(Attrs,Fmt,Args)|T0], Prefix, Ctx,
2221 [ansi(Attrs,Fmt,Args,Ctx)|T]) :-
2222 !,
2223 prefix_nl(T0, Prefix, Ctx, T).
2224prefix_nl([H|T0], Prefix, Ctx, [H|T]) :-
2225 prefix_nl(T0, Prefix, Ctx, T).
2226
2228
2229print_message_lines(Stream, Lines) :-
2230 with_output_to(
2231 Stream,
2232 notrace(print_message_lines_guarded(current_output, Lines))).
2233
2234print_message_lines_guarded(_, []) :- !.
2235print_message_lines_guarded(S, [H|T]) :-
2236 line_element(S, H),
2237 print_message_lines_guarded(S, T).
2238
2239line_element(S, E) :-
2240 prolog:message_line_element(S, E),
2241 !.
2242line_element(S, full_stop) :-
2243 !,
2244 '$put_token'(S, '.'). 2245line_element(S, nl) :-
2246 !,
2247 nl(S).
2248line_element(S, prefix(Fmt-Args)) :-
2249 !,
2250 safe_format(S, Fmt, Args).
2251line_element(S, prefix(Fmt)) :-
2252 !,
2253 safe_format(S, Fmt, []).
2254line_element(S, flush) :-
2255 !,
2256 flush_output(S).
2257line_element(S, Fmt-Args) :-
2258 !,
2259 safe_format(S, Fmt, Args).
2260line_element(S, ansi(_, Fmt, Args)) :-
2261 !,
2262 safe_format(S, Fmt, Args).
2263line_element(S, ansi(_, Fmt, Args, _Ctx)) :-
2264 !,
2265 safe_format(S, Fmt, Args).
2266line_element(S, url(URL)) :-
2267 !,
2268 print_link(S, URL).
2269line_element(S, url(_URL, Fmt-Args)) :-
2270 !,
2271 safe_format(S, Fmt, Args).
2272line_element(S, url(_URL, Fmt)) :-
2273 !,
2274 safe_format(S, Fmt, []).
2275line_element(_, begin(_Level, _Ctx)) :- !.
2276line_element(_, end(_Ctx)) :- !.
2277line_element(S, Fmt) :-
2278 safe_format(S, Fmt, []).
2279
2280print_link(S, File:Line:Column) :-
2281 !,
2282 safe_format(S, '~w:~d:~d', [File, Line, Column]).
2283print_link(S, File:Line) :-
2284 !,
2285 safe_format(S, '~w:~d', [File, Line]).
2286print_link(S, File) :-
2287 safe_format(S, '~w', [File]).
2288
2290
2291safe_format(S, Fmt, Args) :-
2292 E = error(_,_),
2293 catch(format(S,Fmt,Args), E,
2294 format_failed(S,Fmt,Args,E)).
2295
2296format_failed(S, _Fmt, _Args, E) :-
2297 stream_property(S, error(true)),
2298 !,
2299 throw(E).
2300format_failed(S, Fmt, Args, error(E,_)) :-
2301 format(S, '~N [[ EXCEPTION while printing message ~q~n\c
2302 ~7|with arguments ~W:~n\c
2303 ~7|raised: ~W~n~4|]]~n',
2304 [ Fmt,
2305 Args, [quoted(true), max_depth(10)],
2306 E, [quoted(true), max_depth(10)]
2307 ]).
2308
2312
2313message_to_string(Term, Str) :-
2314 translate_message(Term, Actions, []),
2315 !,
2316 actions_to_format(Actions, Fmt, Args),
2317 format(string(Str), Fmt, Args).
2318
2319actions_to_format([], '', []) :- !.
2320actions_to_format([nl], '', []) :- !.
2321actions_to_format([Term, nl], Fmt, Args) :-
2322 !,
2323 actions_to_format([Term], Fmt, Args).
2324actions_to_format([nl|T], Fmt, Args) :-
2325 !,
2326 actions_to_format(T, Fmt0, Args),
2327 atom_concat('~n', Fmt0, Fmt).
2328actions_to_format([ansi(_Attrs, Fmt0, Args0)|Tail], Fmt, Args) :-
2329 !,
2330 actions_to_format(Tail, Fmt1, Args1),
2331 atom_concat(Fmt0, Fmt1, Fmt),
2332 append_args(Args0, Args1, Args).
2333actions_to_format([url(Pos)|Tail], Fmt, Args) :-
2334 !,
2335 actions_to_format(Tail, Fmt1, Args1),
2336 url_actions_to_format(url(Pos), Fmt1, Args1, Fmt, Args).
2337actions_to_format([url(URL, Label)|Tail], Fmt, Args) :-
2338 !,
2339 actions_to_format(Tail, Fmt1, Args1),
2340 url_actions_to_format(url(URL, Label), Fmt1, Args1, Fmt, Args).
2341actions_to_format([Fmt0-Args0|Tail], Fmt, Args) :-
2342 !,
2343 actions_to_format(Tail, Fmt1, Args1),
2344 atom_concat(Fmt0, Fmt1, Fmt),
2345 append_args(Args0, Args1, Args).
2346actions_to_format([Skip|T], Fmt, Args) :-
2347 action_skip(Skip),
2348 !,
2349 actions_to_format(T, Fmt, Args).
2350actions_to_format([Term|Tail], Fmt, Args) :-
2351 atomic(Term),
2352 !,
2353 actions_to_format(Tail, Fmt1, Args),
2354 atom_concat(Term, Fmt1, Fmt).
2355actions_to_format([Term|Tail], Fmt, Args) :-
2356 actions_to_format(Tail, Fmt1, Args1),
2357 atom_concat('~w', Fmt1, Fmt),
2358 append_args([Term], Args1, Args).
2359
2360action_skip(at_same_line).
2361action_skip(flush).
2362action_skip(begin(_Level, _Ctx)).
2363action_skip(end(_Ctx)).
2364
2365url_actions_to_format(url(File:Line:Column), Fmt1, Args1, Fmt, Args) :-
2366 !,
2367 atom_concat('~w:~d:~d', Fmt1, Fmt),
2368 append_args([File,Line,Column], Args1, Args).
2369url_actions_to_format(url(File:Line), Fmt1, Args1, Fmt, Args) :-
2370 !,
2371 atom_concat('~w:~d', Fmt1, Fmt),
2372 append_args([File,Line], Args1, Args).
2373url_actions_to_format(url(File), Fmt1, Args1, Fmt, Args) :-
2374 !,
2375 atom_concat('~w', Fmt1, Fmt),
2376 append_args([File], Args1, Args).
2377url_actions_to_format(url(_URL, Label), Fmt1, Args1, Fmt, Args) :-
2378 !,
2379 atom_concat('~w', Fmt1, Fmt),
2380 append_args([Label], Args1, Args).
2381
2382
2383append_args(M:Args0, Args1, M:Args) :-
2384 !,
2385 strip_module(Args1, _, A1),
2386 to_list(Args0, Args01),
2387 '$append'(Args01, A1, Args).
2388append_args(Args0, Args1, Args) :-
2389 strip_module(Args1, _, A1),
2390 to_list(Args0, Args01),
2391 '$append'(Args01, A1, Args).
2392
2393 2396
2397:- dynamic
2398 printed/2. 2399
2403
2404print_once(compatibility(_), _).
2405print_once(null_byte_in_path(_), _).
2406print_once(deprecated(_), _).
2407
2411
2412must_print(Level, Message) :-
2413 nonvar(Message),
2414 print_once(Message, Level),
2415 !,
2416 \+ printed(Message, Level),
2417 assert(printed(Message, Level)).
2418must_print(_, _)