Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new MISRA C++ 2023 rule implementation for detecting trigraph-like sequences in C++ string literals (RULE-5-0-1), including metadata, exclusions wiring, and tests.
Changes:
- Introduced a new rule package entry
RULE-5-0-1underMISRA-C++-2023describing the trigraph-like sequence rule and its query metadata. - Implemented the
TrigraphLikeSequencesShouldNotBeUsedCodeQL query for C++ string literals and wired it into the exclusions/RuleMetadata infrastructure and VS Code tasks. - Added unit tests (source,
.qlref,.expected) for RULE-5-0-1 covering compliant, non-compliant, and documented false-positive scenarios.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
rule_packages/cpp/Trigraph.json |
Declares MISRA-C++-2023 rule RULE-5-0-1 with properties, query metadata, and implementation scope for trigraph-like sequences. |
cpp/misra/test/rules/RULE-5-0-1/test.cpp |
Adds test cases for string literals containing each trigraph-like sequence plus compliant and COMPLIANT[FALSE_POSITIVE] examples. |
cpp/misra/test/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.qlref |
Points the test harness at the new TrigraphLikeSequencesShouldNotBeUsed.ql query. |
cpp/misra/test/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.expected |
Specifies the expected alerts for each non-compliant test case string literal. |
cpp/misra/src/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.ql |
Implements the MISRA C++ RULE-5-0-1 query, scanning string literals for trigraph-like sequences while accounting for escaped ? characters and hooking into the MISRA exclusions mechanism. |
cpp/common/src/codingstandards/cpp/exclusions/cpp/Trigraph.qll |
Adds the autogenerated TrigraphQuery type, metadata predicate, and TrigraphPackage::trigraphLikeSequencesShouldNotBeUsedQuery() to integrate the rule with the exclusions framework. |
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll |
Wires the new Trigraph package into the global TCPPQuery union and isQueryMetadata dispatcher so the rule participates in exclusions/metadata resolution. |
.vscode/tasks.json |
Extends the rule_package_name picker options with Trigraph to support running/generating this package from VS Code tasks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
MichaelRFairhurst
left a comment
There was a problem hiding this comment.
Nicely done! And, I did not realize that trigraphs were actually removed from C++17, TIL! Yes, this is definitely the right approach, thank you!!
Just a few comments 👍
cpp/misra/src/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.ql
Outdated
Show resolved
Hide resolved
cpp/misra/src/rules/RULE-5-0-1/TrigraphLikeSequencesShouldNotBeUsed.ql
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
please enter the description of your change here
Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.