Skip to content

Commit

Permalink
Create rule S2253 Forbidden functions CPP-5857
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Dec 2, 2024
1 parent b2b1cb9 commit 55c1242
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
3 changes: 3 additions & 0 deletions rules/S2253/cfamily/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"title": "User-specified functions should not be called"
}
25 changes: 25 additions & 0 deletions rules/S2253/cfamily/rule.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
This rule template allows to define rules that ban the call of some functions, for instance functions provided for legacy reasons. It will not prevent calling member functions or macros with the same name.

It comes with two parameters:

* `names` defines a comma-separated list of function names to ban. You can specify a standalone name, in which case the rule will match functions with that name in any namespaces, or a qualified name (for instance, `print` will match `std::print`, but `::print` will not)
* `message` is the message to display when the rule is violated. If you use a `$` in that message, it will be replaced by the name of the function that was called.
=== Noncompliant code example

Given parameters:

* names: f1, ::f2
* message: Don't call $

[source,cpp]
----
void f() {
f1(); // Noncompliant: Don't call f1
my::f1(); // Noncompliant: Don't call f1
f2(); // Noncompliant: Don't call f2
my::f2() // Compliant
}
----

0 comments on commit 55c1242

Please sign in to comment.