..
   This file is part of Logtalk <https://logtalk.org/>
   SPDX-FileCopyrightText: 1998-2025 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 predicate**

.. index:: pair: current_event/5; Built-in predicate
.. _predicates_current_event_5:

``current_event/5``
===================

Description
-----------

::

   current_event(Event, Object, Message, Sender, Monitor)

Enumerates, by backtracking, all defined events. The two types of events
are represented by the atoms ``before`` and ``after``.

Modes and number of proofs
--------------------------

::

   current_event(?event, ?term, ?term, ?term, ?object_identifier) - zero_or_more

Errors
------

| ``Event`` is neither a variable nor a valid event identifier:
|     ``type_error(event, Event)``
| ``Object`` is neither a variable nor a valid object identifier:
|     ``type_error(object_identifier, Object)``
| ``Message`` is neither a variable nor a callable term:
|     ``type_error(callable, Message)``
| ``Sender`` is neither a variable nor a valid object identifier:
|     ``type_error(object_identifier, Sender)``
| ``Monitor`` is neither a variable nor a valid object identifier:
|     ``type_error(object_identifier, Monitor)``

Examples
--------

::

   % enumerate all events monitored by the "debugger" object:
   | ?- current_event(Event, Object, Message, Sender, debugger).

.. seealso::

   :ref:`predicates_abolish_events_5`,
   :ref:`predicates_define_events_5`,
   :ref:`methods_before_3`,
   :ref:`methods_after_3`
