587 lines
7.9 KiB
ReStructuredText
587 lines
7.9 KiB
ReStructuredText
Context Rules
|
|
-------------
|
|
|
|
context_001
|
|
###########
|
|
|
|
This rule checks the indent of the **context** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
library ieee;
|
|
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
library ieee;
|
|
|
|
|
|
context_002
|
|
###########
|
|
|
|
This rule checks for a single space between the **context** keyword and the context identifier.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
context_003
|
|
###########
|
|
|
|
This rule checks for a blank line above the **context** keyword.
|
|
Comment are allowed.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
library ieee;
|
|
context c1 is
|
|
|
|
--Some Comment
|
|
context c1 is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
library ieee;
|
|
|
|
context c1 is
|
|
|
|
--Some Comment
|
|
context c1 is
|
|
|
|
context_004
|
|
###########
|
|
|
|
This rule checks the **context** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
CONTEXT c1 is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
context_005
|
|
###########
|
|
|
|
This rule checks the context identifier is on the same line as the **context** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context
|
|
c1
|
|
is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1
|
|
is
|
|
|
|
context_006
|
|
###########
|
|
|
|
This rule checks the **is** keyword is on the same line as the context identifier.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1
|
|
is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
context_007
|
|
###########
|
|
|
|
This rule checks for code after the **is** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is -- Comments are allowed
|
|
|
|
context c1 is library ieee; -- This is not allowed
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is -- Comments are allowed
|
|
|
|
context c1 is
|
|
library ieee; -- This is not allowed
|
|
|
|
context_008
|
|
###########
|
|
|
|
This rule checks the **end** keyword is on it's own line.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is library ieee; end context c1;
|
|
|
|
context c1 is library ieee; end;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is library ieee;
|
|
end context c1;
|
|
|
|
context c1 is library ieee;
|
|
end;
|
|
|
|
context_009
|
|
###########
|
|
|
|
This rule checks the **context** keyword is on the same line as the end context keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end
|
|
context c1;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context
|
|
c1;
|
|
|
|
context_010
|
|
###########
|
|
|
|
This rule checks the context identifier is on the same line as the end context keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context
|
|
c1;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context c1;
|
|
|
|
context_011
|
|
###########
|
|
|
|
This rule checks the semicolon is on the same line as the **end** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end
|
|
;
|
|
|
|
end context
|
|
;
|
|
|
|
end context c1
|
|
;
|
|
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end;
|
|
|
|
end context;
|
|
|
|
end context c1;
|
|
|
|
|
|
context_012
|
|
###########
|
|
|
|
This rule checks the context identifier has proper case in the context declaration.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context C1 is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
|
|
context_013
|
|
###########
|
|
|
|
This rule checks the **is** keyword has proper case in the context declaration.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 IS
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
context_014
|
|
###########
|
|
|
|
This rule checks the **end** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
End;
|
|
|
|
END context;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end;
|
|
|
|
end context;
|
|
|
|
context_015
|
|
###########
|
|
|
|
This rule checks the context keyword has proper case in the end context declaration.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end CONTEXT;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context;
|
|
|
|
context_016
|
|
###########
|
|
|
|
This rule checks the context identifier has proper case in the end context declaration.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context C1;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context c1;
|
|
|
|
context_017
|
|
###########
|
|
|
|
This rule checks for a single space between the context identifier and the **is** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
context_018
|
|
###########
|
|
|
|
This rule checks for a single space between the **end** keyword and the **context** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end;
|
|
|
|
end context;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end;
|
|
|
|
end context;
|
|
|
|
context_019
|
|
###########
|
|
|
|
This rule checks for a single space between the **context** keyword and the context identifier.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context;
|
|
|
|
end context c1;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context;
|
|
|
|
end context c1;
|
|
|
|
context_020
|
|
###########
|
|
|
|
This rule checks the indent of the **end** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
end context c1;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
end context c1;
|
|
|
|
context_021
|
|
###########
|
|
|
|
This rule checks for the keyword **context** in the **end context** statement.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end c1;
|
|
|
|
end;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context c1;
|
|
|
|
end context;
|
|
|
|
context_022
|
|
###########
|
|
|
|
This rule checks for the context name in the **end context** statement.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context c1;
|
|
|
|
context_023
|
|
###########
|
|
|
|
This rule adds a blank line below the **is** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
library IEEE;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
library IEEE;
|
|
|
|
context_024
|
|
###########
|
|
|
|
This rule adds a blank line above the **end** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
use ieee.std_logic_1164.all;
|
|
end context;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
use ieee.std_logic_1164.all;
|
|
|
|
end context;
|
|
|
|
context_025
|
|
###########
|
|
|
|
This rule adds a blank line below the context semicolon.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context;
|
|
entity fifo is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end context;
|
|
|
|
entity fifo is
|
|
|
|
context_026
|
|
###########
|
|
|
|
This rule ensures a single blank line after the **context** keword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
|
|
|
|
library ieee;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is
|
|
|
|
library ieee;
|
|
|
|
context_027
|
|
###########
|
|
|
|
This rule ensures a single blank line before the **end** keword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
use ieee.std_logic_1164.all;
|
|
|
|
|
|
|
|
end context;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
use ieee.std_logic_1164.all;
|
|
|
|
end context;
|
|
|
|
context_028 (Proposed)
|
|
######################
|
|
|
|
This rule checks for alignment of inline comments in the context declaration.
|
|
|
|
Refer to the section `Configuring Keyword Alignment Rules <configuring_keyword_alignment.html>`_ for information on changing the configurations.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is -- Some comment
|
|
library ieee; -- Other comment
|
|
use ieee.std_logic_1164.all; -- Comment 3
|
|
end context c1; -- Comment 4
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
context c1 is -- Some comment
|
|
library ieee; -- Other comment
|
|
use ieee.std_logic_1164.all; -- Comment 3
|
|
end context c1; -- Comment 4
|
|
|