Address review comments

Author: knewbury01

cpp/misra/src/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.ql

@@ -6,6 +6,7 @@
  * @precision medium
  * @problem.severity warning
  * @tags external/misra/id/rule-5-0-1
+ *       portability
  *       readability
  *       scope/single-translation-unit
  *       external/misra/enforcement/decidable
@@ -15,10 +16,28 @@
 import cpp
 import codingstandards.cpp.misra
 
-from StringLiteral s, int occurrenceOffset
+class CanContainSequenceType extends Locatable {
+  CanContainSequenceType() {
+    this instanceof StringLiteral
+    or
+    this instanceof Comment
+    or
+    this instanceof Macro
+  }
+
+  string getContent() {
+    result = this.(StringLiteral).getValue()
+    or
+    result = this.(Comment).getContents()
+    or
+    result = this.(Macro).getBody()
+  }
+}
+
+from CanContainSequenceType s, int occurrenceOffset, string substring
 where
   not isExcluded(s, TrigraphPackage::trigraphLikeSequencesShouldNotBeUsedQuery()) and
-  exists(s.getValue().regexpFind("\\?\\?[=/'()!<>-]", _, occurrenceOffset)) and
+  substring = s.getContent().regexpFind("\\?\\?[=/'()!<>-]", _, occurrenceOffset) and
   //one escape character is enough to mean this isnt a trigraph-like sequence
-  not exists(s.getASimpleEscapeSequence(_, occurrenceOffset + 1))
-select s, "Trigraph-like sequence used in string literal."
+  not exists(s.(StringLiteral).getASimpleEscapeSequence(_, occurrenceOffset + 1))
+select s, "Trigraph-like sequence found: '" + substring + "'."

cpp/misra/test/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.expected

@@ -1,9 +1,11 @@
-| test.cpp:1:17:1:21 | ??= | Trigraph-like sequence used in string literal. |
-| test.cpp:2:18:2:22 | ??/ | Trigraph-like sequence used in string literal. |
-| test.cpp:3:18:3:22 | ??' | Trigraph-like sequence used in string literal. |
-| test.cpp:4:18:4:22 | ??( | Trigraph-like sequence used in string literal. |
-| test.cpp:5:18:5:22 | ??) | Trigraph-like sequence used in string literal. |
-| test.cpp:6:18:6:22 | ??! | Trigraph-like sequence used in string literal. |
-| test.cpp:7:18:7:22 | ??< | Trigraph-like sequence used in string literal. |
-| test.cpp:8:18:8:22 | ??> | Trigraph-like sequence used in string literal. |
-| test.cpp:9:18:9:22 | ??- | Trigraph-like sequence used in string literal. |
+| test.cpp:1:17:1:21 | ??= | Trigraph-like sequence found: '??='. |
+| test.cpp:2:18:2:22 | ??/ | Trigraph-like sequence found: '??/'. |
+| test.cpp:3:18:3:22 | ??' | Trigraph-like sequence found: '??''. |
+| test.cpp:4:18:4:22 | ??( | Trigraph-like sequence found: '??('. |
+| test.cpp:5:18:5:22 | ??) | Trigraph-like sequence found: '??)'. |
+| test.cpp:6:18:6:22 | ??! | Trigraph-like sequence found: '??!'. |
+| test.cpp:7:18:7:22 | ??< | Trigraph-like sequence found: '??<'. |
+| test.cpp:8:18:8:22 | ??> | Trigraph-like sequence found: '??>'. |
+| test.cpp:9:18:9:22 | ??- | Trigraph-like sequence found: '??-'. |
+| test.cpp:14:1:14:45 | // comment trigraph-like ??= // NON_COMPLIANT | Trigraph-like sequence found: '??='. |
+| test.cpp:17:1:17:25 | #define TRIGRAPH_LIKE ??= | Trigraph-like sequence found: '??='. |

cpp/misra/test/rules/RULE-5-0-1/test.cpp

@@ -9,4 +9,9 @@ const char *g7 = "??>"; // NON_COMPLIANT
 const char *g8 = "??-"; // NON_COMPLIANT
 
 const char *g9 = "\?\?="; // COMPLIANT
-const char *g10 = "?=";   // COMPLIANT
+const char *g10 = "?=";   // COMPLIANT
+
+// comment trigraph-like ??= // NON_COMPLIANT
+
+// clang-format off
+#define TRIGRAPH_LIKE ??= // NON_COMPLIANT - format off otherwise it separates the characters

rule_packages/cpp/Trigraph.json

@@ -14,6 +14,7 @@
           "severity": "warning",
           "short_name": "TrigraphLikeSequencesShouldNotBeUsed",
           "tags": [
+            "portability",
             "readability",
             "scope/single-translation-unit"
           ],