Commit Graph

53 Commits

Author SHA1 Message Date
Jukka Hertzog d508e775f5
Issue#1330 Update naming_rule_group.rst 2024-11-14 11:00:40 +00:00
JHertz5 5b641012e3 Issue#1322: Added documentation for case rules for package instantiations. 2024-11-13 19:06:39 +00:00
Jukka Hertzog acdbbd81cb
Issue#1285: Added case rules for protected type declarations and bodies (#1293)
* Issue#1285: Added case rules for protected type declarations.

* Issue#1285: Added case rules for protected type body declarations.

* Issue#1285: Correction in protected_type_502

* Issue#1285: Added protected_type and protected_type_body to top-level rules object

* Issue#1285: Added tests for protected_type rules

* Issue#1285: Whitespace changes in test cases.

* Issue#1285: Updated protected_type tests.

* Issue#1285: Added tests for protected_type_body rules

* Issue#1285: Updated documentation for protected_type and protected_type_body rules.
2024-11-10 20:00:22 -06:00
Jukka Hertzog 9aaa274bd1
Issue#1284: Deprecate case_013 (#1312)
* Issue#1284: Deprecated rule case_013.

* Issue#1284: Updated tests for deprecated rule case_013.

* Issue#1284: Updated documentation for deprecated rule case_013.

* Issue#1284: Added punctuation to docstring.
2024-11-10 19:07:33 -06:00
Jukka Hertzog 571bc52927
Issue#1251: Added rules to enforce case on parameters in functions and procedures (#1254)
* Issue#1251: Added rules function_507, procedure_508, and procedure_call_502.

* Issue#1251: Updated docstrings and docs for rules function_507, procedure_508, and procedure_call_502.

* Issue#1251: Updated docstrings and docs for rule groups.

* Issue#1251: Updated docstrings and docs for rule groups.

* Issue#1251: Updated expected test output.

* Issue#1251: Updated expected test output.

* Issue#1251: Added tests for rules function_507, procedure_508, and procedure_call_502.

* Issue#1251: Added rules function_508 and procedure_509.

* Issue#1251: Updated docs for function_508 and procedure_509.

* Issue#1251: Updated rule group docs for function_508 and procedure_509.

* Issue#1251: Minor consistency improvement.

* Issue#1251: Removed unused imports.

* Issue#1251: Corrected rules function_507 and procedure_508 to act on interface file declarations

* Issue#1251: Improved tests for function_507 and procedure_508

* Issue#1251: Updated get_function_subprogram_body and get_procedure_subprogram_body to handle nested declarations

* Issue#1251: Updates to consistent_subprogram_parameter_token_case. Still doesn't exclude nested regions unfortunately, but at least handles them perhaps satisfactorily.

* Issue#1251: Added tests for function_508 and procedure_509.

* Issue#1251: Removed unused code.

* Issue#1251: Formatting

* Issue#1251: Updated style tests.

* Issue#1251: Cleanup in consistent_subprogram_parameter_token_case

* Issue#1251: Fixed crash in case of subprogram with no interfaces.

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Updated test file to exercise corner case

* Issue#1251: Removed consistent case changes, to be split into a different PR.
2024-11-10 07:36:31 -06:00
Jukka Hertzog 83bfcfd9d3
Issue#1267: Updated rule return_statement_300 to handle label alignment (#1268)
* Issue#1267: Updated rule return_statement_300 to handle label alignment

* Issue#1267: Removed extra newline from indent_config.yaml

* Issue#1267: Split return label rule out to return_statement_301.

* Issue#1267: Reverted return_statement_300 tests.

* Issue#1267: Added tests for return_statement_301.

* Issue#1267: Added documentation for return_statement_301.
2024-11-09 14:18:19 -06:00
Jukka Hertzog 44544d3060
Issue#1253: Added rule to enforce case of `pure` and `impure` keywords. (#1259)
* Issue#1253: Added rule function_510.

* Issue#1253: Added tests for rule function_510.

* Issue#1253: Updated documentation for rule function_510.

* Issue#1253: Updated documentation for rule function_510.

* Issue#1253: Changed rule function_510 to function_509 to avoid conflict with other in-progress branches.

* Issue#1253: Updated test script.

* Issue#1253: Adjusted whitespace in test files for consistency with other tests.

* Issue#1253: Split rules to act on pure and impure separately.
2024-11-09 14:14:49 -06:00
Jukka Hertzog 980b7cfc74
Issue#1228: Added subtype rules to match type rules (#1229)
* Issue#1228: Added rules subtype_005 and subtype_006.

* Issue#1228: Added test for rule subtype_005.

* Issue#1228: Added test for rule subtype_006.

* Issue#1228: Added rules subtype_007 and subtype_008.

* Issue#1228: Added tests for rules subtype_007 and subtype_008.

* Issue#1228: Added rules subtype_009 and subtype_010.

* Issue#1228: Added tests for rules subtype_009 and subtype_010.

* Issue#1228: Added rule subtype_200.

* Issue#1228: Fixed rule subtype_200.
Removed duplicates from lTokens and lAllowTokens.
Updated code example to avoid duplicate definitions.

* Issue#1228: Added tests for rule subtype_200.

* Issue#1228: Corrections/improvements to new rule docstrings.

* Issue#1228: Reworked rule numbers to reflect execution phases.

* Issue#1228: Updated rule documentation.

* Issue#1228: Updated documentation.

* Issue#1228: Updated rule subtype_102 to include resolution functions.

* Issue#1228: Simplified subtype_102 by using whitespace_after_token instead of whitespace_between_token_pairs.

* Issue#1228: Simplified subtype_101 by using whitespace_before_token instead of whitespace_between_token_pairs.

* Issue#1228: Corrected order of init imports for subtypes.

* Issue#1228: Corrected order of init imports for subtypes.
2024-11-09 14:07:20 -06:00
JHertz5 c14c303097
Issue#1277: Rule for enforcing case on `others` in case statements. (#1278)
* Issue#1277: Added rule case_500.

* Issue#1277: Added tests for rule case_500.

* Issue#1277: Added documentation for rule case_500.
2024-10-20 17:32:01 -05:00
JHertz5 2c60191df3
Issue#1252: Rules for enforcing case on function and procedure parameter directions (#1260)
* Issue#1252: Added rules function_509 and procedure_510.

* Issue#1252: Changed rule function_509 to function_510.

* Issue#1252: Added tests for rules function_509 and procedure_510.

* Issue#1252: Updated documentation for rules function_510 and procedure_510.
2024-10-20 17:07:07 -05:00
JHertz5 150c4d6700
Issue#1263: Rules for enforcing case on parameter class in functions and parameters (#1264)
* Issue#1263: Added rules function_511 and procedure_511.

* Issue#1263: Added tests for rules function_511 and procedure_511.

* Issue#1263: Removed duplicate token in rules function_511 and procedure_511.

* Issue#1263: Updated docstring for rules function_511 and procedure_511.

* Issue#1263: Updated docs for rules function_511 and procedure_511.
2024-10-20 10:52:38 -05:00
JHertz5 44fd761232
Issue#1265: Added rules for next statements (#1266)
* Issue#1265: Added rules next_statement_300, next_statement_500 and next_statement_501.

* Issue#1265: Added tests for rules next_statement_300, next_statement_500 and next_statement_501.

* Issue#1265: Added docs for rules next_statement_300, next_statement_500 and next_statement_501.

* Issue#1265: Update rule next_statement_300 to handle label alignment as well.

* Issue#1265: Updated indent rule group test.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-10-20 10:31:58 -05:00
JHertz5 3d3835a08d
Issue#1275: Added rules for library names in entity instantiations (#1276)
* Issue#1275: Added rule instantiation_500.

* Issue#1275: Added tests for rule instantiation_500.

* Issue#1275: Added documentation for rule instantiation_500.

* Issue#1275: Reverted IEEE rule doc change.

* Issue#1275: Removed excess newline in docstring/documentation.
2024-10-20 10:31:19 -05:00
JHertz5 afb9a1d56e
Issue#1269: Rule to enforce case on exit statements (#1270)
* Issue#1269: Added rules exit_statement_300, exit_statement_500 and exit_statement_501.

* Issue#1269: Added tests for rules exit_statement_300, exit_statement_500 and exit_statement_501.

* Issue#1269: Added docs for rules exit_statement_500 and exit_statement_501.
2024-10-20 10:11:50 -05:00
JHertz5 78c4c5deb6
Issue#1261: Rules for enforcing case in wait statements (#1262)
* Issue#1261: Added rules wait_500, wait_501, wait_502 and wait_503.

* Issue#1261: Added tests for rules wait_500, wait_501, wait_502 and wait_503.

* Issue#1261: Added documentation for rules wait_500, wait_501, wait_502 and wait_503.
2024-10-20 09:47:20 -05:00
JHertz5 d57c9c186b
Issue#1273: Added rules to enforce `in` keywords in for loops/generates (#1274)
* Issue#1273: Added rules for_generate_statement_502 and iteration_scheme_502.

* Issue#1273: Added tests for rules for_generate_statement_502 and iteration_scheme_502.

* Issue#1273: Added documentation for rules for_generate_statement_502 and iteration_scheme_502.
2024-10-20 09:03:37 -05:00
JHertz5 32ff55eb6a
Issue#1271: Added rules for null statements (#1272)
* Issue#1271: Added rules null_statement_300 and null_statement_500.

* Issue#1271: Added tests for rules null_statement_300 and null_statement_500.

* Issue#1271: Added documentation for rules null_statement_300 and null_statement_500.
2024-10-19 11:02:15 -05:00
JHertz5 ce86655850
Issue#1236: Rule for case in hexadecimal constants and base specifier (#1237)
* Issue#1236: Updated parser to recognise bit string literals.

* Issue#1236: Added rules bit_string_literal_500 and bit_string_literal_501.

* Issue#1236: Updated bit string literal tokens to combine quote tokens into bit_value string token.

* Issue#1236: Updated case_utils to add exeption for bit string literals.

* Issue#1236: Updated parser to separate bit_string_literal integer token from bit_string_literal base_specifier token.

* Issue#1236: Added test for bit_string_literal classification.

* Issue#1236: Added test for bit_string_literal_500.

* Issue#1236: Added test for bit_string_literal_501.

* Issue#1236: Updated rules and rule tests.

* Issue#1236: Style updates.

* Issue#1236: Updated classification result.

* Issue#1236: Changed bit_string_literal_501 to default to upper case.

* Issue#1236: Updated tests for bit_string_literal_501 default to upper case change.

* Issue#1236: Formatting changes.

* Issue#1236: Updated fixed versions of code examples.

* Issue#1236: Updated fixed versions of code examples.

* Issue#1236: Code refactoring to reduce duplication.

* Issue#1236: Code refactoring to improve names and remove unused code.

* Issue#1236: Formatting changes.

* Issue#1236: Refactored code to reduce congitive complexity.

* Issue#1236: Refactored code to reduce congitive complexity.

* Issue#1236: Added bit string literal rules to top-level rules documentation.

* Issue#1236: Used compiled regular expressions to improve bit_string_literal parsing.

* Issue#1236: Changed regex strings to raw strings to avoid warnings about invalid escape sequences.

* Issue#1236: Removed unused import.
2024-10-07 20:09:53 -05:00
Jeremiah Leary da84a1be1f
Issue#1170: Adding rules to enforce spaces before generic map and port map assignment operators. (#1173)
* Issue#1170:  Adding rules to enforce spaces before generic map and port map assignment operators.

* Adding ability to parse external names.

  1)  Added parsing of external names
  2)  Added external_signal_name rules

* Adding parsing of external names to productions.

* Fixing rule identifiers.

* Adding external_constant_name rules.

* Adding external_variable_name rules.

* Adding classification of indexes of external names.

* Style issue updates and fixing test.
2024-10-02 21:47:19 -05:00
Jeremiah Leary 3e3f22d999 Fixing documentaton link. 2024-07-12 03:38:33 -05:00
Jeremiah Leary 631d39c246
Issue#1186: Additional whitespace rules added. (#1192)
* Issue#1186:  Additional whitespace rules added.

* Fixing style issues.
2024-07-12 03:19:06 -05:00
Jeremiah Leary 95fabcf752
Issue#1196: Adding rules to check for subprogram designators. (#1197) 2024-07-12 03:14:37 -05:00
Jeremiah Leary aa7f10bd29
Issue#1171: Adding rule whitespace_100 to enforce single spacing around relational operators. (#1172) 2024-07-09 20:39:45 -05:00
Jeremiah Leary 0389ff93f2
Issue#1178: Adding rule component_022 to add or remove optional component_simple_name. (#1179) 2024-06-14 07:04:07 -05:00
Alon Bar-Lev baf22da660 style: apply end-of-file-fixer
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-24 21:16:35 +02:00
Alon Bar-Lev 14feb18176 cleanup: remove unused files
Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
2024-03-23 12:11:17 +02:00
Jeremiah Leary 1ddfeb2929
Issue#947: Rule generate_015 could produce invalid code. (#955)
* Issue#947:  Rule generate_015 could produce invalid code.

* Updating parameters for rules.

* Adding documentation links.
2024-03-09 18:39:34 -06:00
JHertz5 51a95c2096
Issue#1103: Adding structure rules for subprogram specifications. (#1108)
* Issue#1103 Added rule for multiline subprogram specification structure.

* Issue#1103 Added rule function_019.

* Issue#1103 Added rule procedure_013.

* Issue#1103 Restored inteface_list_semicolon to subprogram_specification rule.

* Issue#1103 Documentation updates.

* Issue#1103 Removal of superseded rules.

* Issue#1106 Added unittests for procedure_013.

* Issue#1106 Correction to subprogram specification strucutre to include other kinds of interface element

* Issue#1106 Added unittests for function_019.

* Issue#1106 Updated examples for rules function_019 and procedure_013.

* Issue#1106 Modified subprogram specification defaults to avoid changing existing styles.

* Issue#1103: Updated configuration documentation link for the multiline_subprogram_specification_structure class.

* Issue#1103: Updated default value for the `interface_element` attribute of `multiline_subprogram_specification_structure` rules to `add_new_line`

* Issue#1103: Corrected configuration documentation link for the multiline_subprogram_specification_structure class to be a string instead of a non-existent variable.

* Issue#1103: Corrected the link name for `configuring-procedure-call-statement-rules`.

* Issue#1103: Updated default value for the `interface_element` attribute of `multiline_subprogram_specification_structure` rules to `ignore`.

* Issue#1103: Updated default configuration of subprogram specification rules.

* Issue#1103: Updated JCL style with function_019 settings

* Adding picture to illustrate where options will take affect.

---------

Co-authored-by: Jeremiah Leary <jeremiah.c.leary@gmail.com>
2024-01-27 09:35:04 -06:00
JHertz5 bf66308e32
Issue#1110 Added rules to enforce prefixes and suffixes on generate/loop parameter indentifiers (#1111)
* Issue#1110 Added new rules for prefix/suffix enforcement on loop/generate parameter identifiers.

* Issue#1110 Documentation updates for the new loop/generate rules.

* Issue#1110 Added unit tests for the new loop/generate rules.

* Issue#1110 Documentation updates.
2024-01-21 13:02:00 -06:00
Jeremiah Leary dd644d442d
Issue#551: Fixing scoping of consistent token case rules. (#1052)
* Issue#551:  Fixing scoping of consistent token case rules.

Issue#755:
Issue#998:
Issue#1023

* Updating additional consistent case rules:

  1)  architecture_600
  2)  entity_600
2024-01-21 12:36:29 -06:00
JHertz5 e41bdd8855
Issue#1082: Adding assert rules to match report statement rules functionality. (#1083)
* Issue#1082 Added rules assert_100, assert_101, and assert_102 for whitespace in assert statements.

* Issue#1082 Added documentation for rules assert_100, assert_101, and assert_102.

* Issue#1082 Added tests for rules assert_100, assert_101, and assert_102.

* Issue#1082 Added missing comma to uppercase and lowercase rules page.

* Issue#1082 Added rules assert_500, assert_501, and assert_502 for keyword case in assert statements.

* Issue#1082 Added documentation for rules assert_500, assert_501, and assert_502.

* Issue#1082 Added tests for rules assert_500, assert_501, and assert_502.
2024-01-01 19:07:46 -06:00
Jeremiah Leary c7de28e77c
Issue#1065: Adding 'require_blank_line_unless_pragma' to blank line rules (#1068)
* Issue#1065:  Adding 'require_blank_line_unless_pragma' to blank line rules.

* Adding blank line rules for pragmas:

  * pragma_400
  * pragma_401
  * pragma_402
  * pragma_403

* Updating pragma documentation.

* Adding error checking on invalid pragma configurations.

* Fixing failing tests.
2023-12-17 16:59:55 -06:00
Jeremiah Leary e1282048bf
Issue 815 (#840)
* Updates for issue #815

Adding disabled rule constant_101

* Adding disabled rule variable_100

* Adding disabled rule signal_100

* Adding disabled rule alias_declaration_103.

* Adding disabled rule file_100.

* Adding disabled rule subtype_100.

* Adding disabled rule type_100.

* Adding rule signal_101.

* Adding rule signal_102.

* Adding more rules to enable correct aligment:

  1)  architecture_401
  2)  constant_200
  3)  signal_200
  4)  type_200

* Updated a couple of rules:

  1)  Added option to architecture_026 to optionally align type is keywords
  2)  Removed duplicate rule architecture_401
2023-12-09 08:03:07 -06:00
Jeremiah Leary 0096b7d87c
Issue#882: Moving rule concurrent_007 to conditional_waveforms_001. (#1049) 2023-12-09 08:00:40 -06:00
Jeremiah Leary 5c85734a07
Issue#1054: Adding classification of pragmas. (#1056)
* Issue#1054:  Adding classification of pragmas.

* fix 'keyError: regexp' by dStyle having parse regexp and dConfig not (#1058)

* Adding pragma configuration tests.

* Stopping pragma search if a match is found.

* Refactoring classifications of pragmas to improve performance.

---------

Co-authored-by: Gerard Sharp <43923557+SittingDuc@users.noreply.github.com>
2023-12-03 21:09:52 -06:00
Jeremiah Leary 7ba4904371
Issue#1053: Adding rule to check for reserved words. (#1055)
* Issue#1053:  Adding rule to check for reserved words.

* Removing unused token classes.

* Fixing documentation.
2023-12-01 07:41:39 -06:00
Jeremiah Leary 3931a87a59
Issue#999: Adding rule constant_400 to align => in constant declarations. (#1039) 2023-11-06 16:06:27 -06:00
Jeremiah Leary 74fadc7ae4
Issue 1033: Fixing classification of commas in selected_waveforms. (#1038)
* Issue#1033:  

* Removing unused classifier.

* Removing rule conditional_selected_signal_assignment_400

* Rule was conflicting with rule selected_assignment_400.

* Fixing issue with selected_assignments being considered an array.
2023-10-29 10:36:54 -05:00
Jeremiah Leary acb7de10d4
Issue#942: Moved rule instantiation_023 to port_map_010. (#958) 2023-10-24 16:34:13 -05:00
JHertz5 9a7f235c2d
Issue#1006: Minor documentation fixes (#1007)
* Issue#1006: Corrected code blocks in vim.rst.

* Issue#1006: Moved title to allow it to be found by reference.

* Issue#1006: Removed unused and incorrect link from links.rst.

* Issue#1006: Removed trailing whitespace from structure_optional_rule_group.rst

* Issue#1006: Corrected underline lengths in whitespace_rule_groups.rst
2023-10-24 16:31:48 -05:00
Jeremiah Leary 4e03d021b6
Issue#983: Adding concurent_selected_signal_assignment rules (#1024) 2023-10-23 06:45:02 -05:00
Jeremiah Leary 3d02e0b2c5
Issue-945: Adding rules for return_statement production (#1020) 2023-10-22 06:44:48 -05:00
Jeremiah Leary 6057e10792
Issue#1003: Adding case rules for subtype declarations. (#1004) 2023-10-09 16:51:27 -05:00
JHertz5 92d966de5c
Issue#992: Added all optional item rules to `structure::optional` rule group. (#993)
* Issue#992: Added rules to structure::optional rule group.

* Issue#992: Updated documentation to reflect new structure::optional rule group rules.

* Issue#992: Updated/added tests to check new structure::optional rule group rules.

* Issue#992: Removed test files.

* Issue#992: Removed erroneous newline.
2023-09-08 15:41:39 -05:00
Jeremiah Leary 1430bcbd5d
Issue#976: Added prefix and suffix rules for function designators. (#987) 2023-08-07 18:34:01 -05:00
Jeremiah Leary 3697765cb0
Issue#952: Adding consistent case check for enumerated types. (#956) 2023-08-06 17:37:53 -05:00
JHertz5 a24651383e
Issue#970: Correcting title on Whitespace Rule Group page. (#972)
Co-authored-by: JHertz5 <jukka.herzog@live.co.uk>
2023-08-06 11:50:27 -05:00
JHertz5 dce9d58639
Issue#979 Corrected links in pages within rule_groups directory. (#980)
Co-authored-by: JHertz5 <jukka.herzog@live.co.uk>
2023-08-06 07:20:46 -05:00
Jeremiah Leary bab5fbd1f4
Issue#929: Fixing issue with moving label and the postponed keyword. (#933)
* Issue#929:  Fixing issue with moving label and the postponed keyword.

* Refactoring per code climate.

* Removing unused parameter.

* Adding rule process_039 to enforce postponed on same line as process.
2023-04-20 06:46:52 -05:00
Jeremiah Leary 1f15511992
Issue#918: Adding rules for function and procedure optional keywords. (#939)
* Issue#918:  Adding rules for function and procedure optional keywords.

* Combining left and right base rules.

* Refactoring to improve readability.

* Fixing issue with keyword not being inserted.
2023-04-19 07:01:22 -05:00