Printing status and error messages

Author(s): The CLIP Group.

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.11#233 (2004/5/27, 17:43:49 CEST)

This is a very simple library for printing status and error messages to the console.

• Usage and interface (messages)
• Documentation on exports (messages)
• Documentation on multifiles (messages)
• Documentation on internals (messages)
• Known bugs and planned improvements (messages)

Usage and interface (messages)

Documentation on exports (messages)

PREDICATE: error_message/1:

Meta-predicate with arguments: error_message(addmodule).

Usage: error_message(Text)

• Description: The text provided in Text is printed as an ERROR message.
• The following properties should hold at call time: Text is a string (a list of character codes). (basic_props:string/1)

PREDICATE: error_message/2:

Meta-predicate with arguments: error_message(?,addmodule).

Usage: error_message(Text, ArgList)

• Description: The text provided in Text is printed as an ERROR message, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: error_message/3:

Meta-predicate with arguments: error_message(?,?,addmodule).

Usage: error_message(Lc, Text, ArgList)

• Description: The text provided in Text is printed as an ERROR message, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text, and reporting error location Lc (file and line numbers).
• The following properties should hold at call time: Identifies a program source line. (messages:location/1) Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: warning_message/1:

Meta-predicate with arguments: warning_message(addmodule).

Usage: warning_message(Text)

• Description: The text provided in Text is printed as a WARNING message.
• The following properties should hold at call time: Text is a string (a list of character codes). (basic_props:string/1)

PREDICATE: warning_message/2:

Meta-predicate with arguments: warning_message(?,addmodule).

Usage: warning_message(Text, ArgList)

• Description: The text provided in Text is printed as a WARNING message, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: warning_message/3:

Meta-predicate with arguments: warning_message(?,?,addmodule).

Usage: warning_message(Lc, Text, ArgList)

• Description: The text provided in Text is printed as a WARNING message, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text, and reporting error location Lc (file and line numbers).
• The following properties should hold at call time: Identifies a program source line. (messages:location/1) Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: note_message/1:

Meta-predicate with arguments: note_message(addmodule).

Usage: note_message(Text)

• Description: The text provided in Text is printed as a NOTE.
• The following properties should hold at call time: Text is a string (a list of character codes). (basic_props:string/1)

PREDICATE: note_message/2:

Meta-predicate with arguments: note_message(?,addmodule).

Usage: note_message(Text, ArgList)

• Description: The text provided in Text is printed as a NOTE, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: note_message/3:

Meta-predicate with arguments: note_message(?,?,addmodule).

Usage: note_message(Lc, Text, ArgList)

• Description: The text provided in Text is printed as a NOTE, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text, and reporting error location Lc (file and line numbers).
• The following properties should hold at call time: Identifies a program source line. (messages:location/1) Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: simple_message/1:

Usage: simple_message(Text)

• Description: The text provided in Text is printed.
• The following properties should hold at call time: Text is a string (a list of character codes). (basic_props:string/1)

PREDICATE: simple_message/2:

Usage: simple_message(Text, ArgList)

• Description: The text provided in Text is printed as a message, using the arguments in ArgList.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: optional_message/2:

Usage: optional_message(Text, Opts)

• Description: The text provided in Text is printed as a message, but only if the atom -v is a member of Opts. These predicates are meant to be used for optional messages, which are only to be printed when verbose output is requested explicitly.
• The following properties should hold at call time: Text is a string (a list of character codes). (basic_props:string/1) Opts is a list of atms. (basic_props:list/2)

PREDICATE: optional_message/3:

Usage: optional_message(Text, ArgList, Opts)

• Description: The text provided in Text is printed as a message, using the arguments in ArgList, but only if the atom -v is a member of Opts. These predicates are meant to be used for optional messages, which are only to be printed when verbose output is requested explicitly.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1) Opts is a list of atms. (basic_props:list/2)

PREDICATE: debug_message/1:

Meta-predicate with arguments: debug_message(addmodule).

Usage: debug_message(Text)

• Description: The text provided in Text is printed as a debugging message. These messages are turned on by defining a fact of issue_debug_messages/1 with the module name as argument.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1)

PREDICATE: debug_message/2:

Meta-predicate with arguments: debug_message(?,addmodule).

Usage: debug_message(Text, ArgList)

• Description: The text provided in Text is printed as a debugging message, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text. These messages are turned on by defining a fact of issue_debug_messages/1 which the module name as argument.
• The following properties should hold at call time: Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2. (format:format_control/1) ArgList is a list. (basic_props:list/1)

PREDICATE: debug_goal/2:

Meta-predicate with arguments: debug_goal(goal,addmodule).

Usage: debug_goal(Goal, Text)

• Description: Goal is called. The text provided in Text is then printed as a debugging message. The whole process (including running Goal) is turned on by defining a fact of issue_debug_messages/1 with the module name as argument.

PREDICATE: debug_goal/3:

Meta-predicate with arguments: debug_goal(goal,?,addmodule).

Usage: debug_goal(Goal, Text, ArgList)

• Description: Goal is called. The text provided in Text is then printed as a debugging message, using the arguments in ArgList to interpret any variable-related formatting commands embedded in Text. Note that the variables in ArgList can be computed by Goal. The whole process (including running Goal) is turned on by defining a fact of issue_debug_messages/1 with the module name as argument.

Documentation on multifiles (messages)

PREDICATE: issue_debug_messages/1:

The predicate is multifile.

The predicate is of type data.

Usage: issue_debug_messages(Module)

• Description: Printing of debugging messages is enabled for module Module.
• The following properties should hold upon exit: Module is currently instantiated to an atom. (term_typing:atom/1)

Documentation on internals (messages)

REGTYPE: location/1:

Usage:

• Description: Identifies a program source line.

Known bugs and planned improvements (messages)

• Debug message switching should really be done with an expansion, for performance.

Go to the first, previous, next, last section, table of contents.