4.16.5 Predicate Summary

ask_query(+QueryClass, +Query, +Help, -Answer) hookable

Prints the question Query, then reads and processes user input according to QueryClass, and returns the result of the processing, the abstract answer term Answer. The Help message is printed in case of invalid input.

user:message_hook(+M,+S,+L) hook

intercept the printing of a message

'SU_messages':generate_message(+M,?SO,?S) extendible

determines the mapping from a message term into a sequence of lines of text to be printed

user:generate_message_hook(+M,?S0,?S) hook

intercept message before it is given to 'SU_messages':generate_message/3

goal_source_info(+AGoal, -Goal, -SourceInfo)

Decomposes the annotated goal AGoal into a Goal proper and the SourceInfo descriptor term, indicating the source position of the goal.

user:portray_message(+Severity,+Message) hook

Tells print_message/2 what to do.

print_message(+S,+M) hookable

print a message M of severity S

print_message_lines(+S,+P,+L)

print the message lines L to stream S with prefix P

'SU_messages':query_abbreviation(+T,-P) extendible

specifies one letter abbreviations for responses to queries from the Prolog system

user:query_hook(+QueryClass, +Query, +QueryLines, +Help, +HelpLines, -Answer) hook

Called by ask_query/4 before processing the query. If this predicate succeeds, it is assumed that the query has been processed and nothing further is done.

'SU_messages':query_class(+QueryClass, -Prompt, -InputMethod, -MapMethod, -FailureMode) extendible

Access the parameters of a given QueryClass.

user:query_class_hook(+QueryClass, -Prompt, -InputMethod, -MapMethod, -FailureMode) hook

Provides the user with a method of overriding the call to 'SU_messages':query_class/5 in the preparation phase of query processing. This way the default query class characteristics can be changed.

'SU_messages':query_input(+InputMethod, +Prompt, -RawInput) extendible

Implements the input phase of query processing.

user:query_input_hook(+InputMethod, +Prompt, -RawInput) hook

Provides the user with a method of overriding the call to 'SU_messages':query_input/3 in the input phase of query processing. This way the implementation of the default input methods can be changed.

'SU_messages':query_map(+MapMethod, +RawInput, -Result, -Answer) extendible

Implements the mapping phase of query processing.

user:query_map_hook(+MapMethod, +RawInput, -Result, -Answer) hook

Provides the user with a method of overriding the call to 'SU_messages':query_map/4 in the mapping phase of query processing. This way the implementation of the default map methods can be changed.