Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[clang-tidy] Adding Fuchsia checker for overloaded operators
Adds a check to the Fuchsia module to warn if an operator is overloaded, except move and copy operators. See https://fuchsia.googlesource.com/zircon/+/master/docs/cxx.md for reference. Differential Revision: https://reviews.llvm.org/D41363 llvm-svn: 321363
- Loading branch information
Julie Hockett
committed
Dec 22, 2017
1 parent
9c9b61d
commit a966f45
Showing
8 changed files
with
121 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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
This file contains 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
39 changes: 39 additions & 0 deletions
39
clang-tools-extra/clang-tidy/fuchsia/OverloadedOperatorCheck.cpp
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
//===--- OverloadedOperatorCheck.cpp - clang-tidy--------------------------===// | ||
// | ||
// The LLVM Compiler Infrastructure | ||
// | ||
// This file is distributed under the University of Illinois Open Source | ||
// License. See LICENSE.TXT for details. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#include "OverloadedOperatorCheck.h" | ||
|
||
using namespace clang::ast_matchers; | ||
|
||
namespace clang { | ||
namespace tidy { | ||
namespace fuchsia { | ||
|
||
AST_MATCHER(FunctionDecl, isFuchsiaOverloadedOperator) { | ||
if (const auto *CXXMethodNode = dyn_cast<CXXMethodDecl>(&Node)) { | ||
if (CXXMethodNode->isCopyAssignmentOperator() || | ||
CXXMethodNode->isMoveAssignmentOperator()) | ||
return false; | ||
} | ||
return Node.isOverloadedOperator(); | ||
} | ||
|
||
void OverloadedOperatorCheck::registerMatchers(MatchFinder *Finder) { | ||
Finder->addMatcher(functionDecl(isFuchsiaOverloadedOperator()).bind("decl"), | ||
this); | ||
} | ||
|
||
void OverloadedOperatorCheck::check(const MatchFinder::MatchResult &Result) { | ||
if (const auto *D = Result.Nodes.getNodeAs<FunctionDecl>("decl")) | ||
diag(D->getLocStart(), "cannot overload %0") << D; | ||
} | ||
|
||
} // namespace fuchsia | ||
} // namespace tidy | ||
} // namespace clang |
35 changes: 35 additions & 0 deletions
35
clang-tools-extra/clang-tidy/fuchsia/OverloadedOperatorCheck.h
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
//===--- OverloadedOperatorCheck.h - clang-tidy------------------*- C++ -*-===// | ||
// | ||
// The LLVM Compiler Infrastructure | ||
// | ||
// This file is distributed under the University of Illinois Open Source | ||
// License. See LICENSE.TXT for details. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_FUCHSIA_OVERLOADED_OPERATOR_H | ||
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_FUCHSIA_OVERLOADED_OPERATOR_H | ||
|
||
#include "../ClangTidy.h" | ||
|
||
namespace clang { | ||
namespace tidy { | ||
namespace fuchsia { | ||
|
||
/// Overloading operators is disallowed by the Fuchsia coding standard. | ||
/// | ||
/// For the user-facing documentation see: | ||
/// http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-overloaded-operator.html | ||
class OverloadedOperatorCheck : public ClangTidyCheck { | ||
public: | ||
OverloadedOperatorCheck(StringRef Name, ClangTidyContext *Context) | ||
: ClangTidyCheck(Name, Context) {} | ||
void registerMatchers(ast_matchers::MatchFinder *Finder) override; | ||
void check(const ast_matchers::MatchFinder::MatchResult &Result) override; | ||
}; | ||
|
||
} // namespace fuchsia | ||
} // namespace tidy | ||
} // namespace clang | ||
|
||
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_FUCHSIA_OVERLOADED_OPERATOR_H |
This file contains 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
18 changes: 18 additions & 0 deletions
18
clang-tools-extra/docs/clang-tidy/checks/fuchsia-overloaded-operator.rst
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
.. title:: clang-tidy - fuchsia-overloaded-operator | ||
|
||
fuchsia-overloaded-operator | ||
=========================== | ||
|
||
Warns if an operator is overloaded, except for the assignment (copy and move) | ||
operators. | ||
|
||
For example: | ||
|
||
.. code-block:: c++ | ||
|
||
int operator+(int); // Warning | ||
|
||
B &operator=(const B &Other); // No warning | ||
B &operator=(B &&Other) // No warning | ||
|
||
See the features disallowed in Fuchsia at https://fuchsia.googlesource.com/zircon/+/master/docs/cxx.md |
This file contains 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
18 changes: 18 additions & 0 deletions
18
clang-tools-extra/test/clang-tidy/fuchsia-overloaded-operator.cpp
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
// RUN: %check_clang_tidy %s fuchsia-overloaded-operator %t | ||
|
||
class A { | ||
public: | ||
int operator+(int); | ||
// CHECK-MESSAGES: [[@LINE-1]]:3: warning: cannot overload 'operator+' [fuchsia-overloaded-operator] | ||
}; | ||
|
||
class B { | ||
public: | ||
B &operator=(const B &Other); | ||
// CHECK-MESSAGES-NOT: [[@LINE-1]]:3: warning: cannot overload 'operator=' [fuchsia-overloaded-operator] | ||
B &operator=(B &&Other); | ||
// CHECK-MESSAGES-NOT: [[@LINE-1]]:3: warning: cannot overload 'operator=' [fuchsia-overloaded-operator] | ||
}; | ||
|
||
A operator-(const A& AA, const A& BB); | ||
// CHECK-MESSAGES: [[@LINE-1]]:1: warning: cannot overload 'operator-' [fuchsia-overloaded-operator] |