.. _configuring-procedure-call-statement-rules:

Configuring Procedure Call Statement Rules
-----------------------------------------------------

There are rules which will check indent and formatting of constraints as part of a :code:`concurrent_procedure_call_statement` and :code:`procedure_call_statement`:

.. code-block:: text

   concurrent_procedure_call_statement ::=
       [ label : ] [ postponed ] procedure_call ;

   procedure_call_statement ::=
       [ label : ] procedure_call ;

   procedure_call ::= procedure_name [ ( actual_parameter_part ) ]

   actual_parameter_part ::= parameter_association_list

   association_list ::=
       association_element { , association_element }

   association_element ::=
       [ formal_part => ] actual_part

There are separate rules for the structure of the constraint and the indenting.
Both rules are required to ensure proper formatting of procedure call statements.

There are several options to the structure rules:

.. |values| replace::
   :code:`add_new_line`, :code:`remove_new_line`, :code:`ignore`

.. |values2| replace::
   :code:`remove_new_line`, :code:`ignore`

.. |values3| replace::
   :code:`yes`, :code:`no`

.. |no| replace::
   :code:`no`

.. |green_diamond| image:: img/green_diamond.png

.. |red_penta_star| image:: img/red_penta_star.png

.. |purple_hexa_star| image:: img/purple_hexa_star.png

.. |orange_triangle| image:: img/orange_triangle.png

.. |grey_box| image:: img/grey_box.png

.. |add_new_line| replace::
   The setting :code:`add_new_line` enforces a carriage return (alias "new line") [and, consequently by indentation rules kicking in, also (indirectly) enforces the indentation of the new line]

.. |remove_new_line| replace::
   The setting :code:`remove_new_line` enforces the removal of any potential space and carriage return

.. |ignore| replace::
   The setting :code:`ignore` disables the option and hence no formatting check is done at all: spaces and new lines can be anything

.. |default_add_new_line| replace::
   :code:`add_new_line`

.. |default_remove_new_line| replace::
   :code:`remove_new_line`

.. |default_ignore| replace::
   :code:`ignore`

.. |ignore_single_line| replace::
   :code:`ignore_single_line`

.. |ignore_single_line__yes| replace::
   :code:`yes` = Ignore single line expressions.

.. |ignore_single_line__no| replace::
   :code:`no` =  Apply rules to single line expressions.

+---------------------------------------+--------------------+-----------+---------------------+------------------+-----------------------------+
| Option                                | Symbol             | Values    | Structural Element  | Default Value    | Description                 |
+=======================================+====================+===========+=====================+==================+=============================+
| :code:`first_open_paren`              | |green_diamond|    | |values|  | opening parenthesis | |default_ignore| | * |add_new_line|            |
+---------------------------------------+--------------------+-----------+---------------------+------------------+ * |remove_new_line|         |
| :code:`last_close_paren`              | |red_penta_star|   | |values|  | closing parenthesis | |default_ignore| | * |ignore|                  |
+---------------------------------------+--------------------+-----------+---------------------+------------------+                             |
| :code:`association_element`           | |orange_triangle|  | |values|  | association element | |default_ignore| |                             |
+---------------------------------------+--------------------+-----------+---------------------+------------------+                             |
| :code:`association_list_comma`        | |purple_hexa_star| | |values2| | comma               | |default_ignore| |                             |
+---------------------------------------+--------------------+-----------+---------------------+------------------+-----------------------------+
| :code:`ignore_single_line`            | N/A                | |values3| | N/A                 | |no|             | * |ignore_single_line__yes| |
|                                       |                    |           |                     |                  | * |ignore_single_line__no|  |
+---------------------------------------+--------------------+-----------+---------------------+------------------+-----------------------------+

The following figure illustrates where the options will be applied in an procedure call.

.. image:: img/concurrent_procedure_call_code.png

The following configuration replicates the above code snippet.

.. code-block:: yaml

   rule :
     procedure_call_003:
        first_open_paren : 'remove_new_line'
        last_close_paren : 'add_new_line'
        association_list_comma : 'remove_new_line'
        association_element: 'add_new_line'
        ignore_single_line : 'no'

.. NOTE:: All examples use the above configuration.

Example: :code:`first_open_paren` set to :code:`add_new_line`
#############################################################

Setting the :code:`first_open_paren` option to :code:`add_new_line` will result in the following formatting:

.. code-block:: vhdl

   test_harness
   (
       enabled => true,
       sequence => "test_001",
       logging => "full"
   );

Example: :code:`last_close_paren` set to :code:`remove_new_line`
################################################################

Setting the :code:`last_close_paren` option to :code:`remove_new_line` will result in the following formatting:

.. code-block:: vhdl

   test_harness(
       enabled => true,
       sequence => "test_001",
       logging => "full");

Example: :code:`association_element` set to :code:`remove_new_line`
###################################################################

Setting the :code:`association_element` option to :code:`remove_new_line` will result in the following formatting:

.. code-block:: vhdl

   test_harness(enabled => true, sequence => "test_001", logging => "full"
   );

Rules Enforcing Procedure Call Structure
########################################

* `procedure_call_003 <procedure_call_rules.html#procedure-call-003>`_