..
   This file is part of Logtalk <https://logtalk.org/>  
   Copyright 1998-2018 Paulo Moura <pmoura@logtalk.org>

   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.


.. index:: call//1-N
.. _methods_call_1:

call//1-N
=========

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

::

   call(Closure)
   call(Closure, Arg1, ...)
   call(Object::Closure, Arg1, ...)
   call(::Closure, Arg1, ...)

This non-terminal takes a closure and is processed by appending the
input list of tokens and the list of remaining tokens to the arguments
of the closure. This built-in non-terminal is interpreted as a private
non-terminal and thus cannot be used as a message to an object. When
using a backend Prolog compiler supporting a module system, calls in
the format ``call(Module:Closure)`` may also be used. By using as
argument a :term:`lambda expression`, this built-in non-terminal can
provide controlled access to the input list of tokens and to the list
of the remaining tokens processed by the grammar rule containing the call.

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

::

   call(+callable) - zero_or_more
   call(+callable, ?term) - zero_or_more
   call(+callable, ?term, ?term) - zero_or_more
   ...

Errors
------

| Closure is a variable:
|     ``instantiation_error``
| Closure is neither a variable nor a callable term:
|     ``type_error(callable, Closure)``

Examples
--------

| Calls a goal, constructed by appending the tokens difference list to the closure, in in the context of the object or category containing the call:
|     ``call(Closure)``
| To send a goal, constructed by appending the tokens difference list to the closure, as a message to :term:`self`:
|     ``call(::Closure)``
| To send a goal, constructed by appending the tokens difference list to the closure, as a message to an explicit object:
|     ``call(Object::Closure)``

.. seealso::

   :ref:`methods_eos_0`,
   :ref:`methods_phrase_1`,
   :ref:`methods_phrase_2`,
   :ref:`methods_phrase_3`
