compilerplugins/clang/check.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #pragma once
  11
  12 #include <cstddef>
  13
  14 #include <clang/AST/DeclBase.h>
  15 #include <clang/AST/Decl.h>
  16 #include <clang/AST/Type.h>
  17 #include <clang/Basic/OperatorKinds.h>
  18
  19 namespace loplugin {
  20
  21 class ContextCheck;
  22 class TerminalCheck;
  23
  24 namespace detail {
  25
  26 inline ContextCheck checkRecordDecl(
  27     clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id);
  28
  29 }
  30
  31 class DeclCheck;
  32
  33 class TypeCheck {
  34 public:
  35     explicit TypeCheck(clang::QualType type): type_(type) {}
  36
  37     explicit TypeCheck(clang::Type const * type): type_(type, 0) {}
  38
  39     explicit TypeCheck(clang::TypeDecl const * decl): type_(decl->getTypeForDecl(), 0) {}
  40
  41     explicit operator bool() const { return !type_.isNull(); }
  42
  43     TypeCheck NonConst() const;
  44
  45     TypeCheck NonConstVolatile() const;
  46
  47     TypeCheck Const() const;
  48
  49     TypeCheck Volatile() const;
  50
  51     TypeCheck ConstVolatile() const;
  52
  53     TypeCheck ConstNonVolatile() const;
  54
  55     TerminalCheck Void() const;
  56
  57     TerminalCheck Char() const;
  58
  59     TerminalCheck AnyBoolean() const;
  60
  61     TypeCheck Pointer() const;
  62
  63     TerminalCheck Enum() const;
  64
  65     TypeCheck LvalueReference() const;
  66
  67     TypeCheck RvalueReference() const;
  68
  69     inline ContextCheck Class(llvm::StringRef id) const;
  70
  71     inline ContextCheck Struct(llvm::StringRef id) const;
  72
  73     inline ContextCheck ClassOrStruct(llvm::StringRef id) const;
  74
  75     TypeCheck Typedef() const;
  76
  77     inline ContextCheck Typedef(llvm::StringRef id) const;
  78
  79     DeclCheck TemplateSpecializationClass() const;
  80
  81     TypeCheck NotSubstTemplateTypeParmType() const;
  82
  83 private:
  84     TypeCheck() = default;
  85
  86     clang::QualType const type_{};
  87 };
  88
  89 class DeclCheck {
  90     friend TypeCheck;
  91
  92 public:
  93     explicit DeclCheck(clang::Decl const * decl): decl_(decl) {}
  94
  95     explicit operator bool() const { return decl_ != nullptr; }
  96
  97     inline ContextCheck Class(llvm::StringRef id) const;
  98
  99     inline ContextCheck Struct(llvm::StringRef id) const;
 100
 101     inline ContextCheck ClassOrStruct(llvm::StringRef id) const;
 102
 103     inline ContextCheck Union(llvm::StringRef id) const;
 104
 105     inline ContextCheck Function(llvm::StringRef id) const;
 106
 107     ContextCheck Operator(clang::OverloadedOperatorKind op) const;
 108
 109     inline ContextCheck Var(llvm::StringRef id) const;
 110
 111     ContextCheck MemberFunction() const;
 112
 113 private:
 114     DeclCheck() = default;
 115
 116     clang::Decl const * const decl_ = nullptr;
 117 };
 118
 119 class ContextCheck {
 120 public:
 121     explicit ContextCheck(clang::DeclContext const * context = nullptr):
 122         context_(context) {}
 123
 124     explicit operator bool() const { return context_ != nullptr; }
 125
 126     TerminalCheck GlobalNamespace() const;
 127
 128     inline ContextCheck Namespace(llvm::StringRef id) const;
 129
 130     TerminalCheck StdNamespace() const;
 131
 132     TerminalCheck StdOrNestedNamespace() const;
 133
 134     ContextCheck AnonymousNamespace() const;
 135
 136     inline ContextCheck Class(llvm::StringRef id) const;
 137
 138     inline ContextCheck Struct(llvm::StringRef id) const;
 139
 140     explicit ContextCheck(const clang::NamespaceDecl * decl ) : context_( decl ) {}
 141
 142 private:
 143     clang::DeclContext const * lookThroughLinkageSpec() const;
 144
 145     clang::DeclContext const * const context_;
 146 };
 147
 148 class TerminalCheck {
 149 public:
 150     explicit operator bool() const { return satisfied_; }
 151
 152 private:
 153     friend ContextCheck;
 154     friend TypeCheck;
 155
 156     explicit TerminalCheck(bool satisfied): satisfied_(satisfied) {}
 157
 158     bool const satisfied_;
 159 };
 160
 161
 162 typedef std::function<bool(clang::Decl const *)> DeclChecker;
 163 // Returns true if the class has a base matching the checker, or, when checkSelf is true, if the
 164 // class itself matches.
 165 bool isDerivedFrom(const clang::CXXRecordDecl *decl, DeclChecker base, bool checkSelf = true);
 166
 167
 168 namespace detail {
 169
 170 ContextCheck checkRecordDecl(
 171     clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id)
 172 {
 173     auto r = llvm::dyn_cast_or_null<clang::RecordDecl>(decl);
 174     if (r != nullptr && r->getTagKind() == tag) {
 175         auto const i = r->getIdentifier();
 176         if (i != nullptr && i->getName() == id) {
 177             return ContextCheck(r->getDeclContext());
 178         }
 179     }
 180     return ContextCheck();
 181 }
 182
 183 }
 184
 185 ContextCheck TypeCheck::Class(llvm::StringRef id)
 186     const
 187 {
 188     if (!type_.isNull()) {
 189         auto const t = type_->getAs<clang::RecordType>();
 190         if (t != nullptr) {
 191             return detail::checkRecordDecl(t->getDecl(), clang::TTK_Class, id);
 192         }
 193     }
 194     return ContextCheck();
 195 }
 196
 197 ContextCheck TypeCheck::Struct(llvm::StringRef id) const
 198 {
 199     if (!type_.isNull()) {
 200         auto const t = type_->getAs<clang::RecordType>();
 201         if (t != nullptr) {
 202             return detail::checkRecordDecl(t->getDecl(), clang::TTK_Struct, id);
 203         }
 204     }
 205     return ContextCheck();
 206 }
 207
 208 ContextCheck TypeCheck::ClassOrStruct(llvm::StringRef id) const
 209 {
 210     auto const c1 = Class(id);
 211     if (c1) {
 212         return c1;
 213     }
 214     return Struct(id);
 215 }
 216
 217 ContextCheck TypeCheck::Typedef(llvm::StringRef id) const
 218 {
 219     if (!type_.isNull()) {
 220         if (auto const t = type_->getAs<clang::TypedefType>()) {
 221             auto const d = t->getDecl();
 222             auto const i = d->getIdentifier();
 223             assert(i != nullptr);
 224             if (i->getName() == id) {
 225                 return ContextCheck(d->getDeclContext());
 226             }
 227         }
 228     }
 229     return ContextCheck();
 230 }
 231
 232 ContextCheck DeclCheck::Class(llvm::StringRef id) const
 233 {
 234     return detail::checkRecordDecl(decl_, clang::TTK_Class, id);
 235 }
 236
 237 ContextCheck DeclCheck::Struct(llvm::StringRef id) const
 238 {
 239     return detail::checkRecordDecl(decl_, clang::TTK_Struct, id);
 240 }
 241
 242 ContextCheck DeclCheck::ClassOrStruct(llvm::StringRef id) const
 243 {
 244     auto const c1 = Class(id);
 245     if (c1) {
 246         return c1;
 247     }
 248     return Struct(id);
 249 }
 250
 251 ContextCheck DeclCheck::Union(llvm::StringRef id) const
 252 {
 253     return detail::checkRecordDecl(decl_, clang::TTK_Union, id);
 254 }
 255
 256 ContextCheck DeclCheck::Function(llvm::StringRef id) const
 257 {
 258     auto f = llvm::dyn_cast_or_null<clang::FunctionDecl>(decl_);
 259     if (f != nullptr) {
 260         auto const i = f->getIdentifier();
 261         if (i != nullptr && i->getName() == id) {
 262             return ContextCheck(f->getDeclContext());
 263         }
 264     }
 265     return ContextCheck();
 266 }
 267
 268 ContextCheck DeclCheck::Var(llvm::StringRef id) const
 269 {
 270     auto f = llvm::dyn_cast_or_null<clang::VarDecl>(decl_);
 271     if (f != nullptr) {
 272         auto const i = f->getIdentifier();
 273         if (i != nullptr && i->getName() == id) {
 274             return ContextCheck(f->getDeclContext());
 275         }
 276     }
 277     return ContextCheck();
 278 }
 279
 280 ContextCheck ContextCheck::Namespace(llvm::StringRef id) const
 281 {
 282     if (context_) {
 283         auto n = llvm::dyn_cast<clang::NamespaceDecl>(lookThroughLinkageSpec());
 284         if (n != nullptr) {
 285             auto const i = n->getIdentifier();
 286             if (i != nullptr && i->getName() == id) {
 287                 return ContextCheck(n->getParent());
 288             }
 289         }
 290     }
 291     return ContextCheck();
 292 }
 293
 294 ContextCheck ContextCheck::Class(llvm::StringRef id) const
 295 {
 296     return detail::checkRecordDecl(
 297         llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Class, id);
 298 }
 299
 300 ContextCheck ContextCheck::Struct(llvm::StringRef id) const
 301 {
 302     return detail::checkRecordDecl(
 303         llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Struct, id);
 304 }
 305
 306 bool isExtraWarnUnusedType(clang::QualType type);
 307
 308 bool isOkToRemoveArithmeticCast(
 309     clang::ASTContext & context, clang::QualType t1, clang::QualType t2,
 310     const clang::Expr* subExpr);
 311
 312 }
 313
 314 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */