-
Notifications
You must be signed in to change notification settings - Fork 73
Add trigraph rule RULE-5-0-1 #1022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| where | ||
| not isExcluded(s, TrigraphPackage::trigraphLikeSequencesShouldNotBeUsedQuery()) and | ||
| exists(s.getValue().regexpFind("\\?\\?[=/'()!<>-]", _, occurrenceOffset)) and | ||
| //one escape character is enough to mean this isnt a trigraph-like sequence |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment //one escape character is enough to mean this isnt a trigraph-like sequence contains a spelling/grammar issue; isnt should be written as isn't for clarity and consistency with surrounding documentation comments.
| //one escape character is enough to mean this isnt a trigraph-like sequence | |
| //one escape character is enough to mean this isn't a trigraph-like sequence |
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.