.. This file is part of Logtalk https://logtalk.org/ SPDX-FileCopyrightText: 1998-2024 Paulo Moura <pmoura@logtalk.org> SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

.. rst-class:: align-right

built-in method

.. index:: pair: print_message/3; Built-in method .. _methods_print_message_3:

print_message/3

Description

::

print_message(Kind, Component, Term)

Built-in method for printing a message represented by a term, which is converted to the message text using the :ref:`logtalk::message_tokens(Term, Component) <methods_message_tokens_2>` hook non-terminal. This method is declared in the :ref:`logtalk apis:logtalk/0` built-in object as a public predicate. The line prefix and the output stream used for each Kind-Component pair can be found using the :ref:`logtalk::message_prefix_stream(Kind, Component, Prefix, Stream) <methods_message_prefix_stream_4>` hook predicate.

This predicate starts by converting the message term to a list of tokens and by calling the :ref:`logtalk::message_hook(Message, Kind, Component, Tokens) <methods_message_hook_4>` hook predicate. If this predicate succeeds, the print_message/3 predicate assumes that the message has been successfully printed.

By default: messages of kind debug or debug(_) are only printed when the debug flag is turned on; messages of kind banner, comment, or comment(_) are only printed when the report flag is set to on; messages of kind warning and warning(_) are not printed when the report flag is set to off; messages of kind silent and silent() are not printed (but can be intercepted).

Modes and number of proofs

::

print_message(+nonvar, +nonvar, +nonvar) - one

Errors

(none)

Examples

::

..., logtalk::print_message(information, core, redefining_entity(object, foo)), ...

.. seealso::

:ref:methods_message_hook_4, :ref:methods_message_prefix_stream_4, :ref:methods_message_tokens_2, :ref:methods_print_message_tokens_3, :ref:methods_print_message_token_4, :ref:methods_ask_question_5, :ref:methods_question_hook_6, :ref:methods_question_prompt_stream_4