Issue#1420: Delimited comment tokens were not classified correctly. (#1422)

Author: jeremiah-c-leary

tests/vhdlFile/delimited_comment/classification_results.txt

@@ -0,0 +1,38 @@
+--------------------------------------------------------------------------------
+0 |
+--------------------------------------------------------------------------------
+1 | /**
+<class 'vsg.token.delimited_comment.beginning'>
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+2 |
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+3 | This should pass
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+4 |
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+5 | */
+<class 'vsg.token.delimited_comment.ending'>
+--------------------------------------------------------------------------------
+6 |
+<class 'vsg.parser.blank_line'>
+--------------------------------------------------------------------------------
+7 | /**
+<class 'vsg.token.delimited_comment.beginning'>
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+8 |
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+9 | This should also pass
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+10 |
+<class 'vsg.token.delimited_comment.text'>
+--------------------------------------------------------------------------------
+11 | **/
+<class 'vsg.token.delimited_comment.text'>
+<class 'vsg.token.delimited_comment.ending'>

tests/vhdlFile/delimited_comment/classification_test_input.vhd

@@ -0,0 +1,11 @@
+/**
+
+This should pass
+
+*/
+
+/**
+
+This should also pass
+
+**/

vsg/vhdlFile/classify/comment.py

@@ -19,10 +19,34 @@ def classify(lTokens, lObjects, oOptions):
 
 
 def classify_closing_comment_delimiters(iToken, lObjects, oOptions):
+    if ending_token_exists(iToken, lObjects, oOptions):
+        replace_token_with_ending_token(iToken, lObjects, oOptions)
+        oOptions.clear_inside_delimited_comment()
+    elif ending_token_should_exist(iToken, lObjects, oOptions):
+        replace_token_with_ending_token(iToken, lObjects, oOptions)
+        remove_last_star_from_previous_token(iToken, lObjects, oOptions)
+        oOptions.clear_inside_delimited_comment()
+
+
+def ending_token_exists(iToken, lObjects, oOptions):
+    return oOptions.inside_delimited_comment() and lObjects[iToken].get_value() == "*/"
+
+
+def ending_token_should_exist(iToken, lObjects, oOptions):
+    return oOptions.inside_delimited_comment() and lObjects[iToken].get_value() == "/" and lObjects[iToken - 1].get_value().endswith("*")
+
+
+def replace_token_with_ending_token(iToken, lObjects, oOptions):
     sToken = lObjects[iToken].get_value()
-    if oOptions.inside_delimited_comment() and sToken == "*/":
+    if sToken == "*/":
         lObjects[iToken] = token.ending(sToken)
-        oOptions.clear_inside_delimited_comment()
+    else:
+        lObjects[iToken] = token.ending("*" + sToken)
+
+
+def remove_last_star_from_previous_token(iToken, lObjects, oOptions):
+    sToken = lObjects[iToken - 1].get_value()[:-1]
+    lObjects[iToken - 1] = token.text(sToken)
 
 
 def classify_opening_comment_delimiters(iToken, lObjects, oOptions):

vsg/vhdlFile/vhdlFile.py

@@ -6,6 +6,7 @@
     aggregate,
     attribute_name,
     choices,
+    delimited_comment,
     direction,
     exponent,
     logical_operator,
@@ -523,6 +524,9 @@ def post_token_assignments(lTokens):
     lParenId = []
     for iToken, oToken in enumerate(lTokens):
         sValue = oToken.get_value()
+        if isinstance(oToken, delimited_comment.text):
+            continue
+
         if isinstance(oToken, (resolution_indication.resolution_function_name, type_mark.name, attribute_name.name, todo.name)):
             sLowerValue = oToken.get_lower_value()