Skip to content

Conversation

@MichaelRFairhurst
Copy link
Collaborator

@MichaelRFairhurst MichaelRFairhurst commented Aug 23, 2025

Description

Implement naming package.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • RULE 5-10-1
  • Queries have been modified for the following rules:
    • Rules that use macro arguments now treat variadic parameters better

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
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.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

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

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

@MichaelRFairhurst
Copy link
Collaborator Author

Note that the unicode data came from advanced-security/codeql-qtil#13

I should definitely finish unicode support in qtil, publish, and then use that here. Likely, that should be done before merge, but not strictly necessary.

@MichaelRFairhurst
Copy link
Collaborator Author

Relevant qtil pull request: advanced-security/codeql-qtil#13

@mbaluda mbaluda requested review from mbaluda and removed request for lcartey December 11, 2025 19:02
Copilot AI review requested due to automatic review settings December 11, 2025 19:03
Copy link
Contributor

Copilot AI left a 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 implements a comprehensive naming validation package for MISRA C++ RULE-5-10-1, which enforces proper identifier formation in C++ code. The implementation introduces a sophisticated identifier tracking system that validates identifiers against multiple constraints including Unicode normalization, reserved names, namespace restrictions, and macro naming conventions.

Key changes:

  • Introduces the IdentifierIntroduction abstraction that systematically captures all identifier declarations across various C++ constructs (variables, functions, types, macros, namespaces, templates, etc.)
  • Implements Unicode support with UAX#44 compliance checking and NFC normalization validation using extensible predicates with external YAML data
  • Adds MISRA C++ RULE-5-10-1 query to detect poorly formed identifiers including underscore violations, lowercase in macros, reserved names, and reserved namespace usage

Reviewed changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
cpp/common/src/codingstandards/cpp/Identifiers.qll Introduces comprehensive IdentifierIntroduction class hierarchy that systematically tracks all identifier declarations across various C++ constructs
cpp/common/src/codingstandards/cpp/Unicode.qll Implements Unicode property checking (NFC_QC, XID_Start, XID_Continue) and unicode escape sequence handling for identifier validation
cpp/common/src/codingstandards/cpp/Macro.qll Fixes variadic macro parameter extraction to properly exclude ellipsis and empty parameter names
cpp/misra/src/rules/RULE-5-10-1/PoorlyFormedIdentifier.ql Implements the main query that validates identifiers against MISRA C++ RULE-5-10-1 constraints
cpp/common/src/codingstandards/cpp/exclusions/cpp/Naming2.qll Autogenerated metadata for Naming2 package query registration
cpp/common/src/codingstandards/cpp/exclusions/cpp/RuleMetadata.qll Registers Naming2 package in the rule metadata system
rule_packages/cpp/Naming2.json Defines query metadata for RULE-5-10-1 including severity, precision, and tags
cpp/misra/test/rules/RULE-5-10-1/test.cpp Comprehensive test file with 189 lines covering Unicode, normalization, underscores, macros, namespaces, and reserved names
cpp/misra/test/rules/RULE-5-10-1/PoorlyFormedIdentifier.expected Expected query results showing 48 violations across various identifier validation rules
cpp/misra/test/rules/RULE-5-10-1/PoorlyFormedIdentifier.qlref Query reference file for test execution
cpp/common/test/library/codingstandards/cpp/identifiers/* Library test suite with 666 lines testing identifier extraction across all C++ constructs
cpp/common/test/includes/standard-library/utility.h Adds pair and tuple support for structured binding tests
cpp/common/src/qlpack.yml Registers unicode.yml data extension
change_notes/2025-08-22-function-like-macro-param-name-bug-fixes.md Documents bug fixes in function-like macro parameter handling

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 97 to 100
exists(Function func | func = intro.getElement().(FunctionDeclarationEntry).getFunction() |
isUserDefinedLiteralSuffixNonCompliant(func) and
message = "User-defined literal suffix '" + ident + "' is malformed."
)
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This condition appears unreachable. The query checks if the element is a FunctionDeclarationEntry with a Function that has a malformed user-defined literal suffix, and then tries to use 'ident' in the message. However, for user-defined literal suffixes, the identifier extracted on line 53 via 'intro.unescapeUnicode()' will be the suffix without the 'operator ""' prefix (e.g., '_foo'), not the full function name. This means this branch would never match the conditions in 'isUserDefinedLiteralSuffixNonCompliant' which checks for patterns in the full function name like 'operator""%'. This clause should either be removed as unreachable or the logic should be corrected to properly handle this case.

Suggested change
exists(Function func | func = intro.getElement().(FunctionDeclarationEntry).getFunction() |
isUserDefinedLiteralSuffixNonCompliant(func) and
message = "User-defined literal suffix '" + ident + "' is malformed."
)

Copilot uses AI. Check for mistakes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MichaelRFairhurst could this explain the missing alert for test.cpp:71?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled, but required some offset trickery!

Thanks for catching this!

Copy link
Collaborator

@mbaluda mbaluda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One regex fix and a couple of inconsistent test annotations... looks great otherwise!

int varα = 2; // COMPLIANT - XID_Continue character
int var_γ = 3; // COMPLIANT - underscore and XID_Continue
int var⁺invalid = 5; // NON_COMPLIANT - U+207A not in XID_Continue class
int var̃ = 6; // COMPLIANT - combining tilde, XID_Continue but not XID_Start
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
int var̃ = 6; // COMPLIANT - combining tilde, XID_Continue but not XID_Start
int var̃ = 6; // NON_COMPLIANT - combining tilde, XID_Continue but not XID_Start

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting.

This test was I guess intending to test combining marks that are in XID_Continue, but tilde is not NFC form.

I switched this to an NFC form combining mark (one that doesn't ever precompose). This also prompted me to add a test in the NFC form section that checks a number of additional NFC form combining marks.

Comment on lines 97 to 100
exists(Function func | func = intro.getElement().(FunctionDeclarationEntry).getFunction() |
isUserDefinedLiteralSuffixNonCompliant(func) and
message = "User-defined literal suffix '" + ident + "' is malformed."
)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MichaelRFairhurst could this explain the missing alert for test.cpp:71?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants