Merge remote-tracking branch 'origin/master' into issue-1492

Author: JHertz5

docs/architecture_rules.rst

@@ -516,6 +516,7 @@ architecture_025
 This rule checks for valid names for the architecture.
 Typical architecture names are:  RTL, EMPTY, and BEHAVE.
 This rule allows the user to restrict what can be used for an architecture name.
+Note that regular expressions are accepted in the **names** field.
 
 .. NOTE:: This rule is disabled by default.
    You can enable and configure the names using the following configuration.
@@ -531,6 +532,7 @@ This rule allows the user to restrict what can be used for an architecture name.
             - rtl
             - empty
             - behave
+            - my_pattern.*
 
 **Violation**
 

docs/configuring.rst

@@ -19,6 +19,7 @@ Configuring
    configuring_indent_rules.rst
    configuring_keyword_alignment_rules.rst
    configuring_length_rules.rst
+   configuring_library_and_package_name_restriction_rules.rst
    configuring_move_token_rules.rst
    configuring_multiline_assert_rule.rst
    configuring_multiline_constraint_rules.rst

docs/configuring_disabled_rules.rst

@@ -59,10 +59,9 @@ Rules Disabled by Default
 * `generic_map_601 <generic_map_rules.html#generic-map-601>`_
 * `instantiation_600 <instantiation_rules.html#instantiation-600>`_
 * `instantiation_601 <instantiation_rules.html#instantiation-601>`_
-
 * `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
 * `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
-
+* `library_012 <library_rules.html#library-012>`_
 * `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
 * `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
 * `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
@@ -102,6 +101,7 @@ Rules Disabled by Default
 * `type_100 <type_rules.html#type-100>`_
 * `type_200 <type_rules.html#type-200>`_
 * `type_600 <type_rules.html#type-600>`_
+* `use_clause_001 <use_clause_rules.html#use-clause-001>`_
 * `variable_012 <variable_rules.html#variable-012>`_
 * `variable_100 <variable_rules.html#variable-100>`_
 * `variable_600 <variable_rules.html#variable-600>`_

docs/configuring_library_and_package_name_restriction_rules.rst

@@ -0,0 +1,70 @@
+
+.. _configuring-library-and-package-name-restriction-rules:
+
+Configuring Library and Package Name Restriction Rules
+------------------------------------------------------
+
+There are rules which will check for invalid package names in library and use clauses.
+These rules are disabled by default and must be enabled before they will perform any checks.
+
+There is one option for these rules:
+
+.. |names| replace::
+   :code:`names`
+
+.. |default| replace::
+   :code:`std_logic_arith` for **use_clause_001**. None for **library_012**
+
+.. |values__names| replace::
+   List of strings
+
+.. |action__names| replace::
+   Search for libraries and packages with the user defined names
+
++--------------------------------------+-----------------+-----------+------------------------------------------------+
+| Option                               |   Values        | Default   | Description                                    |
++======================================+=================+===========+================================================+
+| |names|                              | |values__names| | |default| | * |action__names|                              |
++--------------------------------------+-----------------+-----------+------------------------------------------------+
+
+This is an example of how to configure the option.
+
+.. code-block:: yaml
+
+   rule :
+     library_012:
+        names:
+          - "work"
+          - "std_logic_arith"
+
+.. NOTE:: All examples below are using the rule **use_clause_001**.
+
+Example: |names| set to list ["std_logic_arith"]
+################################################
+
+The following code would fail with this option:
+
+.. code-Block:: vhdl
+
+   library ieee;
+     use ieee.std_logic_arith.all;
+
+Example: |names| set to ["std_logic_arith", "my_package"]
+##############################################
+
+The following code would fail three times with this option:
+
+.. code-block:: vhdl
+
+   library ieee;
+     use ieee.std_logic_arith.all;
+
+   library work;
+     use work.my_package.all;
+
+
+Rules Enforcing Valid Names
+###########################
+
+* `library_012 <library_rules.html#library-012>`_
+* `use_clause_001 <use_clause_rules.html#use-clause-001>`_

docs/configuring_type_of_instantiations.rst

@@ -41,7 +41,7 @@ This is an example of how to configure these options.
 .. code-block:: yaml
 
    rule :
-     instantiation_010:
+     instantiation_034:
         method: 'component'
 
 Example: |method| set to |component_option|

docs/configuring_vhdl_reserved_words.rst

@@ -28,11 +28,14 @@ These rules provide the following options:
 .. |standard__2008| replace::
    :code:`2008` = Use reserved keywords from 2008 standard
 
+.. |standard__2019| replace::
+   :code:`2019` = Use reserved keywords from 2019 standard
+
 .. |standard__all| replace::
    :code:`all` = Use reserved keywords from all standards
 
 .. |values| replace::
-   :code:`1987`, :code:`1993`, :code:`2000`, :code:`2002`, :code:`2008`
+   :code:`1987`, :code:`1993`, :code:`2000`, :code:`2002`, :code:`2008`, :code:`2019`
 
 .. |default_value| replace::
    :code:`all`
@@ -45,6 +48,7 @@ These rules provide the following options:
 |                      |          |                 | * |standard__2000|         |
 |                      |          |                 | * |standard__2002|         |
 |                      |          |                 | * |standard__2008|         |
+|                      |          |                 | * |standard__2019|         |
 |                      |          |                 | * |standard__all|          |
 +----------------------+----------+-----------------+----------------------------+
 
@@ -96,6 +100,19 @@ The :code:`context` keyword is a reserved word in the 2008 standard.
        end entity;
 
 
+Example: |standard_option| set to :code:`2019`
+##############################################
+
+The :code:`private` keyword is a reserved word in the 2019 standard.
+
+    **Violation**
+
+    .. code-block:: yaml
+
+       entity private is
+       end entity;
+
+
 Rules Enforcing Optional Items
 ##############################
 

docs/configuring_whitespace_rules.rst

@@ -191,7 +191,12 @@ Rules Enforcing Whitespace
 * `external_variable_name_102 <external_variable_name_rules.html#external-variable-name-102>`_
 * `external_variable_name_103 <external_variable_name_rules.html#external-variable-name-103>`_
 * `external_variable_name_104 <external_variable_name_rules.html#external-variable-name-104>`_
+* `file_open_information_100 <file_open_information_rules.html#file-open-information-100>`_
+* `file_open_information_101 <file_open_information_rules.html#file-open-information-101>`_
+* `file_open_information_102 <file_open_information_rules.html#file-open-information-102>`_
+* `file_open_information_103 <file_open_information_rules.html#file-open-information-103>`_
 * `file_100 <file_rules.html#file-100>`_
+* `file_101 <file_rules.html#file-101>`_
 * `function_100 <function_rules.html#function-100>`_
 * `function_101 <function_rules.html#function-101>`_
 * `generate_002 <generate_rules.html#generate-002>`_
@@ -210,6 +215,8 @@ Rules Enforcing Whitespace
 * `if_004 <if_rules.html#if-004>`_
 * `if_005 <if_rules.html#if-005>`_
 * `if_015 <if_rules.html#if-015>`_
+* `index_subtype_definition_100 <index_subtype_definition_rules.html#index-subtype-definition-100>`_
+* `index_subtype_definition_101 <index_subtype_definition_rules.html#index-subtype-definition-101>`_
 * `instantiation_002 <instantiation_rules.html#instantiation-002>`_
 * `instantiation_003 <instantiation_rules.html#instantiation-003>`_
 * `instantiation_032 <instantiation_rules.html#instantiation-032>`_
@@ -247,6 +254,8 @@ Rules Enforcing Whitespace
 * `process_014 <process_rules.html#process-014>`_
 * `process_024 <process_rules.html#process-024>`_
 * `process_025 <process_rules.html#process-025>`_
+* `range_constraint_100 <range_constraint_rules.html#range-constraint-100>`_
+* `range_constraint_101 <range_constraint_rules.html#range-constraint-101>`_
 * `record_type_definition_100 <record_type_definition_rules.html#record-type-definition-100>`_
 * `record_type_definition_101 <record_type_definition_rules.html#record-type-definition-101>`_
 * `report_statement_100 <report_statement_rules.html#report-statement-100>`_
@@ -289,3 +298,5 @@ Rules Enforcing Whitespace
 * `variable_assignment_002 <variable_assignment_rules.html#variable-assignment-002>`_
 * `variable_assignment_003 <variable_assignment_rules.html#variable-assignment-003>`_
 * `whitespace_007 <whitespace_rules.html#whitespace-007>`_
+* `whitespace_102 <whitespace_rules.html#whitespace-102>`_
+* `whitespace_103 <whitespace_rules.html#whitespace-103>`_

docs/file_open_information_rules.rst

@@ -3,6 +3,90 @@
 File Open Information Rules
 ---------------------------
 
+file_open_information_100
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **open** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type      open read_mode is load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_open_information_101
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **open** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open     read_mode is load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_open_information_102
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **is** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode     is load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_open_information_103
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **is** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is         load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
 file_open_information_500
 #########################
 

docs/file_rules.rst

@@ -92,6 +92,27 @@ This rule checks for a single space before the identifier.
 
 **Fix**
 
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_101
+########
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the identifier.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage        : load_file_type open read_mode is load_file_name;
+
+**Fix**
+
 .. code-block:: vhdl
 
    file defaultImage : load_file_type open read_mode is load_file_name;

docs/index_subtype_definition_rules.rst

@@ -3,6 +3,48 @@
 Index Subtype Definition Rules
 ------------------------------
 
+index_subtype_definition_100
+############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **range** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural     range <>) of integer;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural range <>) of integer;
+
+index_subtype_definition_101
+############################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **range** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural range     <>) of integer;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   type my_array is array (natural range <>) of integer;
+
 index_subtype_definition_500
 ############################