Fix missing carriage return handling for rules moving token to previous line (#1455)

Author: benthie

tests/record_type_definition/rule_007_test_input.fixed.vhd

@@ -13,6 +13,8 @@ architecture rtl of fifo is
 
   type t_record is record a : std_logic; b : std_logic; end record;
 
+  type my_array1 is array (natural range 0 to 3) of std_logic ;   -- white space before semicolon here
+
 begin
 
 end architecture rtl;

tests/record_type_definition/rule_007_test_input.vhd

@@ -15,6 +15,8 @@ architecture rtl of fifo is
   type t_record is record a : std_logic; b : std_logic; end record
   ;
 
+  type my_array1 is array (natural range 0 to 3) of std_logic ;   -- white space before semicolon here
+
 begin
 
 end architecture rtl;

vsg/rules/constant/rule_007.py

@@ -33,3 +33,4 @@ class rule_007(Rule):
     def __init__(self):
         super().__init__(lTokens)
         self.bRemoveTrailingWhitespace = False
+        self.solution = "Move := operator"

vsg/rules/entity/rule_024.py

@@ -33,3 +33,4 @@ def __init__(self):
         super().__init__(lTokens)
         self.subphase = 2
         self.bRemoveTrailingWhitespace = False
+        self.solution = "Move entity simple name"

vsg/rules/entity/rule_025.py

@@ -33,3 +33,4 @@ def __init__(self):
         super().__init__(lTokens)
         self.bInsertWhitespace = False
         self.subphase = 3
+        self.solution = "Move semicolon"

vsg/rules/generic/rule_021.py

@@ -34,3 +34,4 @@ class rule_021(Rule):
     def __init__(self):
         super().__init__(lTokens)
         self.bInsertWhitespace = False
+        self.solution = "Move semicolon"

vsg/rules/if_statement/rule_036.py

@@ -27,3 +27,4 @@ class rule_036(Rule):
 
     def __init__(self):
         super().__init__(lTokens)
+        self.solution = "Move **then** keyword"

vsg/rules/instantiation/rule_035.py

@@ -34,3 +34,4 @@ class rule_035(Rule):
     def __init__(self):
         super().__init__(lTokens)
         self.bInsertWhitespace = False
+        self.solution = "Move semicolon"

vsg/rules/move_token_left_to_next_non_whitespace_token.py

@@ -43,7 +43,7 @@ def _get_tokens_of_interest(self, oFile):
         lReturn = []
         for oToi in lToi:
             lTokens = oToi.get_tokens()
-            if skip_based_on_whitespace(self.bInsertWhitespace, lTokens):
+            if self.skip_based_on_whitespace(self.bInsertWhitespace, lTokens):
                 continue
             if oToi.token_type_exists(token.pragma.pragma):
                 continue
@@ -54,7 +54,7 @@ def _analyze(self, lToi):
         for oToi in lToi:
             lTokens = oToi.get_tokens()
 
-            sSolution = "Move **then** keyword to same line as " + lTokens[0].get_value()
+            sSolution = self.solution + " to same line as " + lTokens[0].get_value()
             oViolation = violation.New(oToi.get_line_number(), oToi, sSolution)
             oViolation.set_remap()
             oViolation.fix_blank_lines = True
@@ -77,14 +77,12 @@ def _fix_violation(self, oViolation):
 
         oViolation.set_tokens(lNewTokens)
 
+    def does_a_whitespace_token_separate_tokens(self, lTokens):
+        if len(lTokens) == 3 and isinstance(lTokens[1], parser.whitespace):
+            return True
+        return False
 
-def does_a_whitespace_token_separate_tokens(lTokens):
-    if len(lTokens) == 3 and isinstance(lTokens[1], parser.whitespace):
-        return True
-    return False
-
-
-def skip_based_on_whitespace(bInsertWhitespace, lTokens):
-    if bInsertWhitespace and does_a_whitespace_token_separate_tokens(lTokens):
-        return True
-    return False
+    def skip_based_on_whitespace(self, bInsertWhitespace, lTokens):
+        if bInsertWhitespace and self.does_a_whitespace_token_separate_tokens(lTokens):
+            return True
+        return False

vsg/rules/port/rule_027.py

@@ -34,3 +34,4 @@ class rule_027(Rule):
     def __init__(self):
         super().__init__(lTokens)
         self.bInsertWhitespace = False
+        self.solution = "Move semicolon"