Message printing primitives

Usage:message(Type,Message)

Output to standard error Message, which is of type Type. The quiet prolog flag (see Runtime system control and flags) controls which messages are actually output, depending on its type. Also, for error, warning, and note messages, a prefix is output which denotes the severity of the message.

• The following properties should hold at call time:
  (messages_basic:message_type/1)Type is one of the accepted message types.
  (messages_basic:lformat_text/1)Message is an item or a list of items from the following:

  $$(String)

  String is a string, which is output with write_string/1.

  ''(Term)

  Term is output quoted. If the module write is loaded, the term is output with writeq/1, else with displayq/1.

  ~~(Term)

  Term is output unquoted. If the module write is loaded, the term is output with write/1, else with display/1.

  ''({Term})

  Term is output quoted. If the module write is loaded, the term is output with printq/1, else with displayq/1.

  {Term}

  Term is output unquoted. If the module write is loaded, the term is output with print/1, else with display/1.

  [](Term)

  Term is recursively output as a message, can be an item or a list of items from this list.

  Term

  Any other term is output with display/1.

Usage:message_lns(Type,L0,L1,Message)

Output to standard error Message, which is of type Type, and occurs between lines L0 and L1. This is the same as message/2, but printing the lines where the message occurs in a unified way (this is useful because automatic tools such as the emacs mode know how to parse them).

• The following properties should hold at call time:
  (messages_basic:message_type/1)Type is one of the accepted message types.
  (basic_props:nnegint/1)L0 is a non-negative integer.
  (basic_props:nnegint/1)L1 is a non-negative integer.
  (messages_basic:lformat_text/1)Message is an item or a list of items from the following:

  $$(String)

  String is a string, which is output with write_string/1.

  ''(Term)

  Term is output quoted. If the module write is loaded, the term is output with writeq/1, else with displayq/1.

  ~~(Term)

  Term is output unquoted. If the module write is loaded, the term is output with write/1, else with display/1.

  ''({Term})

  Term is output quoted. If the module write is loaded, the term is output with printq/1, else with displayq/1.

  {Term}

  Term is output unquoted. If the module write is loaded, the term is output with print/1, else with display/1.

  [](Term)

  Term is recursively output as a message, can be an item or a list of items from this list.

  Term

  Any other term is output with display/1.

Usage:messages(Messages)

Print each element in Messages using message/2 or message_lns/4 predicates.

• The following properties should hold at call time:
  (basic_props:list/2)Messages is a list of message_infos.

Usage:message_type_visible(Type)

Succeeds if message type Type is visible according to the current value of the quiet prolog flag

• The following properties should hold at call time:
  (messages_basic:message_type/1)Type is one of the accepted message types.

Usage:lformat(T)

Output a formatted text T. See lformat_text/1 for a description of the text formatting.

• The following properties should hold at call time:
  (messages_basic:lformat_text/1)T is an item or a list of items from the following:

  $$(String)

  String is a string, which is output with write_string/1.

  ''(Term)

  Term is output quoted. If the module write is loaded, the term is output with writeq/1, else with displayq/1.

  ~~(Term)

  Term is output unquoted. If the module write is loaded, the term is output with write/1, else with display/1.

  ''({Term})

  Term is output quoted. If the module write is loaded, the term is output with printq/1, else with displayq/1.

  {Term}

  Term is output unquoted. If the module write is loaded, the term is output with print/1, else with display/1.

  [](Term)

  Term is recursively output as a message, can be an item or a list of items from this list.

  Term

  Any other term is output with display/1.

Outputs List. If List is a list, do display/1 on each of its elements, else do display/1 on List.

Usage:

The type of the elements to be printed using the messages/1 predicate. Defined as

message_info(message_lns(Source,Ln0,Ln1,Type,Text)) :-
    atm(Source),
    nnegint(Ln0),
    nnegint(Ln1),
    message_type(Type),
    lformat_text(Text).
message_info(message(Type,Text)) :-
    atm(Type),
    lformat_text(Text).
message_info(error(Text)) :-
    lformat_text(Text).
message_info(warning(Text)) :-
    lformat_text(Text).
message_info(note(Text)) :-
    lformat_text(Text).
message_info(message(Text)) :-
    lformat_text(Text).
message_info(debug(Text)) :-
    lformat_text(Text).

message_type(error).
message_type(error0).
message_type(warning).
message_type(note).
message_type(user).
message_type(inform).
message_type(debug).
message_type(passed).
message_type(failed).
message_type(aborted).
message_type(testing).

Usage:message_type(M)

M is one of the accepted message types.

Usage:lformat_text(Message)

Message is an item or a list of items from the following:

$$(String)

String is a string, which is output with write_string/1.

''(Term)

Term is output quoted. If the module write is loaded, the term is output with writeq/1, else with displayq/1.

~~(Term)

Term is output unquoted. If the module write is loaded, the term is output with write/1, else with display/1.

''({Term})

Term is output quoted. If the module write is loaded, the term is output with printq/1, else with displayq/1.

{Term}

Term is output unquoted. If the module write is loaded, the term is output with print/1, else with display/1.

[](Term)

Term is recursively output as a message, can be an item or a list of items from this list.

Term

Any other term is output with display/1.