juliehockett created this revision.
juliehockett added a project: clang-tools-extra.
Herald added subscribers: xazax.hun, mgorny.
Adds a check to the Fuchsia module to warn if classes are defined or created
with virtual inheritance.
See https://fuchsia.googlesource.com/zircon/+/master/docs/cxx.md for reference.
https://reviews.llvm.org/D40813
Files:
clang-tidy/fuchsia/CMakeLists.txt
clang-tidy/fuchsia/FuchsiaTidyModule.cpp
clang-tidy/fuchsia/VirtualInheritanceCheck.cpp
clang-tidy/fuchsia/VirtualInheritanceCheck.h
docs/ReleaseNotes.rst
docs/clang-tidy/checks/fuchsia-virtual-inheritance.rst
docs/clang-tidy/checks/list.rst
test/clang-tidy/fuchsia-virtual-inheritance.cpp
Index: test/clang-tidy/fuchsia-virtual-inheritance.cpp
===================================================================
--- /dev/null
+++ test/clang-tidy/fuchsia-virtual-inheritance.cpp
@@ -0,0 +1,54 @@
+// RUN: %check_clang_tidy %s fuchsia-virtual-inheritance %t
+
+class A {
+public:
+ A(int value) : val(value) {}
+
+ int do_A() { return val; }
+
+private:
+ int val;
+};
+
+class B : public virtual A {
+ // CHECK-MESSAGES: [[@LINE-1]]:1: warning: virtual inheritance is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: class B : public virtual A {
+public:
+ B() : A(0) {}
+ int do_B() { return 1 + do_A(); }
+};
+
+class C : public virtual A {
+ // CHECK-MESSAGES: [[@LINE-1]]:1: warning: virtual inheritance is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: class C : public virtual A {
+public:
+ C() : A(0) {}
+ int do_C() { return 2 + do_A(); }
+};
+
+class D : public B, public C {
+ // CHECK-MESSAGES: [[@LINE-1]]:1: warning: virtual inheritance is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: class C : public B, public C {
+public:
+ D(int value) : A(value), B(), C() {}
+ // CHECK-MESSAGES: [[@LINE-1]]:28: warning: constructing a class which inherits a virtual base class is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: D(int value) : A(value), B(), C() {}
+ // CHECK-MESSAGES: [[@LINE-3]]:33: warning: constructing a class which inherits a virtual base class is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: D(int value) : A(value), B(), C() {}
+
+ int do_D() { return do_A() + do_B() + do_C(); }
+};
+
+int main(void) {
+ A *a = new A(0);
+ B *b = new B();
+ // CHECK-MESSAGES: [[@LINE-1]]:14: warning: constructing a class which inherits a virtual base class is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: B *b = new B();
+ C *c = new C();
+ // CHECK-MESSAGES: [[@LINE-1]]:14: warning: constructing a class which inherits a virtual base class is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: C *c = new C();
+ D *d = new D(0);
+ // CHECK-MESSAGES: [[@LINE-1]]:14: warning: constructing a class which inherits a virtual base class is disallowed [fuchsia-virtual-inheritance]
+ // CHECK-NEXT: D *d = new D(0);
+ return 0;
+}
Index: docs/clang-tidy/checks/list.rst
===================================================================
--- docs/clang-tidy/checks/list.rst
+++ docs/clang-tidy/checks/list.rst
@@ -69,6 +69,7 @@
cppcoreguidelines-slicing
cppcoreguidelines-special-member-functions
fuchsia-default-arguments
+ fuchsia-virtual-inheritance
google-build-explicit-make-pair
google-build-namespaces
google-build-using-namespace
Index: docs/clang-tidy/checks/fuchsia-virtual-inheritance.rst
===================================================================
--- /dev/null
+++ docs/clang-tidy/checks/fuchsia-virtual-inheritance.rst
@@ -0,0 +1,20 @@
+.. title:: clang-tidy - fuchsia-virtual-inheritance
+
+fuchsia-virtual-inheritance
+===========================
+
+Warns if classes are defined or created with virtual inheritance.
+
+For example, classes should not be defined with virtual inheritance:
+
+.. code-block:: c++
+
+ class B : public virtual A {} // warning
+
+Classes with virtual inheritance should not be created:
+
+.. code-block:: c++
+
+ B *b = new B(); // warning
+
+See the features disallowed in Fuchsia at https://fuchsia.googlesource.com/zircon/+/master/docs/cxx.md
Index: docs/ReleaseNotes.rst
===================================================================
--- docs/ReleaseNotes.rst
+++ docs/ReleaseNotes.rst
@@ -134,7 +134,12 @@
<http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-default-arguments.html>`_ check
Warns if a function or method is declared or called with default arguments.
+
+- New `fuchsia-virtual-inheritance
+ <http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-virtual-inheritance.html>`_ check
+ Warns if classes are defined or created with virtual inheritance.
+
- New `google-objc-avoid-throwing-exception
<http://clang.llvm.org/extra/clang-tidy/checks/google-objc-avoid-throwing-exception.html>`_ check
Index: clang-tidy/fuchsia/VirtualInheritanceCheck.h
===================================================================
--- /dev/null
+++ clang-tidy/fuchsia/VirtualInheritanceCheck.h
@@ -0,0 +1,35 @@
+//===--- VirtualInheritanceCheck.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_VIRTUAL_INHERITANCE_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_FUCHSIA_VIRTUAL_INHERITANCE_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+namespace fuchsia {
+
+/// Defining classes with virtual inheritance is disallowed.
+///
+/// For the user-facing documentation see:
+/// http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-virtual-inheritance.html
+class VirtualInheritanceCheck : public ClangTidyCheck {
+public:
+ VirtualInheritanceCheck(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_VIRTUAL_INHERITANCE_H
Index: clang-tidy/fuchsia/VirtualInheritanceCheck.cpp
===================================================================
--- /dev/null
+++ clang-tidy/fuchsia/VirtualInheritanceCheck.cpp
@@ -0,0 +1,50 @@
+//===--- VirtualInheritanceCheck.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 "VirtualInheritanceCheck.h"
+#include "clang/AST/ASTContext.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace fuchsia {
+
+AST_MATCHER(CXXRecordDecl, hasVirtualBaseClass) {
+ return Node.hasDefinition() && (Node.getNumVBases() != 0);
+}
+
+void VirtualInheritanceCheck::registerMatchers(MatchFinder *Finder) {
+ // Defining classes using virtual inheritance is disallowed.
+ Finder->addMatcher(cxxRecordDecl(hasVirtualBaseClass()).bind("decl"), this);
+ // Calling constructors of classes using virtual inheritance is disallowed.
+ // To clarify, this matcher finds, in order:
+ // 1) Calls to Constructors,
+ // 2) The declarations of those constructors,
+ // 3) The classes those constructors belong to,
+ // 4) And matches the classes which have virtual base classes.
+ Finder->addMatcher(
+ cxxConstructExpr(hasDeclaration(cxxConstructorDecl(
+ ofClass(cxxRecordDecl(hasVirtualBaseClass())))))
+ .bind("stmt"),
+ this);
+}
+
+void VirtualInheritanceCheck::check(const MatchFinder::MatchResult &Result) {
+ if (const auto *D = Result.Nodes.getNodeAs<CXXRecordDecl>("decl"))
+ diag(D->getLocStart(), "virtual inheritance is disallowed");
+ else if (const auto *S = Result.Nodes.getNodeAs<CXXConstructExpr>("stmt"))
+ diag(S->getLocStart(), "constructing a class which inherits a virtual base "
+ "class is disallowed");
+}
+
+} // namespace fuchsia
+} // namespace tidy
+} // namespace clang
Index: clang-tidy/fuchsia/FuchsiaTidyModule.cpp
===================================================================
--- clang-tidy/fuchsia/FuchsiaTidyModule.cpp
+++ clang-tidy/fuchsia/FuchsiaTidyModule.cpp
@@ -11,6 +11,7 @@
#include "../ClangTidyModule.h"
#include "../ClangTidyModuleRegistry.h"
#include "DefaultArgumentsCheck.h"
+#include "VirtualInheritanceCheck.h"
using namespace clang::ast_matchers;
@@ -24,6 +25,8 @@
void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
CheckFactories.registerCheck<DefaultArgumentsCheck>(
"fuchsia-default-arguments");
+ CheckFactories.registerCheck<VirtualInheritanceCheck>(
+ "fuchsia-virtual-inheritance");
}
};
// Register the FuchsiaTidyModule using this statically initialized variable.
Index: clang-tidy/fuchsia/CMakeLists.txt
===================================================================
--- clang-tidy/fuchsia/CMakeLists.txt
+++ clang-tidy/fuchsia/CMakeLists.txt
@@ -3,6 +3,7 @@
add_clang_library(clangTidyFuchsiaModule
DefaultArgumentsCheck.cpp
FuchsiaTidyModule.cpp
+ VirtualInheritanceCheck.cpp
LINK_LIBS
clangAST
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
