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     inline ContextCheck Class(llvm::StringRef id) const;
  68
  69     inline ContextCheck Struct(llvm::StringRef id) const;
  70
  71     inline ContextCheck ClassOrStruct(llvm::StringRef id) const;
  72
  73     TypeCheck Typedef() const;
  74
  75     inline ContextCheck Typedef(llvm::StringRef id) const;
  76
  77     DeclCheck TemplateSpecializationClass() const;
  78
  79     TypeCheck NotSubstTemplateTypeParmType() const;
  80
  81 private:
  82     TypeCheck() = default;
  83
  84     clang::QualType const type_{};
  85 };
  86
  87 class DeclCheck {
  88     friend TypeCheck;
  89
  90 public:
  91     explicit DeclCheck(clang::Decl const * decl): decl_(decl) {}
  92
  93     explicit operator bool() const { return decl_ != nullptr; }
  94
  95     inline ContextCheck Class(llvm::StringRef id) const;
  96
  97     inline ContextCheck Struct(llvm::StringRef id) const;
  98
  99     inline ContextCheck ClassOrStruct(llvm::StringRef id) const;
 100
 101     inline ContextCheck Union(llvm::StringRef id) const;
 102
 103     inline ContextCheck Function(llvm::StringRef id) const;
 104
 105     ContextCheck Operator(clang::OverloadedOperatorKind op) const;
 106
 107     inline ContextCheck Var(llvm::StringRef id) const;
 108
 109     ContextCheck MemberFunction() const;
 110
 111 private:
 112     DeclCheck() = default;
 113
 114     clang::Decl const * const decl_ = nullptr;
 115 };
 116
 117 class ContextCheck {
 118 public:
 119     explicit ContextCheck(clang::DeclContext const * context = nullptr):
 120         context_(context) {}
 121
 122     explicit operator bool() const { return context_ != nullptr; }
 123
 124     TerminalCheck GlobalNamespace() const;
 125
 126     inline ContextCheck Namespace(llvm::StringRef id) const;
 127
 128     TerminalCheck StdNamespace() const;
 129
 130     TerminalCheck StdOrNestedNamespace() const;
 131
 132     ContextCheck AnonymousNamespace() const;
 133
 134     inline ContextCheck Class(llvm::StringRef id) const;
 135
 136     inline ContextCheck Struct(llvm::StringRef id) const;
 137
 138     explicit ContextCheck(const clang::NamespaceDecl * decl ) : context_( decl ) {}
 139
 140 private:
 141     clang::DeclContext const * const context_;
 142 };
 143
 144 class TerminalCheck {
 145 public:
 146     explicit operator bool() const { return satisfied_; }
 147
 148 private:
 149     friend ContextCheck;
 150     friend TypeCheck;
 151
 152     explicit TerminalCheck(bool satisfied): satisfied_(satisfied) {}
 153
 154     bool const satisfied_;
 155 };
 156
 157
 158 typedef std::function<bool(clang::Decl const *)> DeclChecker;
 159 // Returns true if the class has a base matching the checker, or if the class itself matches.
 160 bool isDerivedFrom(const clang::CXXRecordDecl *decl, DeclChecker base);
 161
 162
 163 namespace detail {
 164
 165 ContextCheck checkRecordDecl(
 166     clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id)
 167 {
 168     auto r = llvm::dyn_cast_or_null<clang::RecordDecl>(decl);
 169     if (r != nullptr && r->getTagKind() == tag) {
 170         auto const i = r->getIdentifier();
 171         if (i != nullptr && i->getName() == id) {
 172             return ContextCheck(r->getDeclContext());
 173         }
 174     }
 175     return ContextCheck();
 176 }
 177
 178 }
 179
 180 ContextCheck TypeCheck::Class(llvm::StringRef id)
 181     const
 182 {
 183     if (!type_.isNull()) {
 184         auto const t = type_->getAs<clang::RecordType>();
 185         if (t != nullptr) {
 186             return detail::checkRecordDecl(t->getDecl(), clang::TTK_Class, id);
 187         }
 188     }
 189     return ContextCheck();
 190 }
 191
 192 ContextCheck TypeCheck::Struct(llvm::StringRef id) const
 193 {
 194     if (!type_.isNull()) {
 195         auto const t = type_->getAs<clang::RecordType>();
 196         if (t != nullptr) {
 197             return detail::checkRecordDecl(t->getDecl(), clang::TTK_Struct, id);
 198         }
 199     }
 200     return ContextCheck();
 201 }
 202
 203 ContextCheck TypeCheck::ClassOrStruct(llvm::StringRef id) const
 204 {
 205     auto const c1 = Class(id);
 206     if (c1) {
 207         return c1;
 208     }
 209     return Struct(id);
 210 }
 211
 212 ContextCheck TypeCheck::Typedef(llvm::StringRef id) const
 213 {
 214     if (!type_.isNull()) {
 215         if (auto const t = type_->getAs<clang::TypedefType>()) {
 216             auto const d = t->getDecl();
 217             auto const i = d->getIdentifier();
 218             assert(i != nullptr);
 219             if (i->getName() == id) {
 220                 return ContextCheck(d->getDeclContext());
 221             }
 222         }
 223     }
 224     return ContextCheck();
 225 }
 226
 227 ContextCheck DeclCheck::Class(llvm::StringRef id) const
 228 {
 229     return detail::checkRecordDecl(decl_, clang::TTK_Class, id);
 230 }
 231
 232 ContextCheck DeclCheck::Struct(llvm::StringRef id) const
 233 {
 234     return detail::checkRecordDecl(decl_, clang::TTK_Struct, id);
 235 }
 236
 237 ContextCheck DeclCheck::ClassOrStruct(llvm::StringRef id) const
 238 {
 239     auto const c1 = Class(id);
 240     if (c1) {
 241         return c1;
 242     }
 243     return Struct(id);
 244 }
 245
 246 ContextCheck DeclCheck::Union(llvm::StringRef id) const
 247 {
 248     return detail::checkRecordDecl(decl_, clang::TTK_Union, id);
 249 }
 250
 251 ContextCheck DeclCheck::Function(llvm::StringRef id) const
 252 {
 253     auto f = llvm::dyn_cast_or_null<clang::FunctionDecl>(decl_);
 254     if (f != nullptr) {
 255         auto const i = f->getIdentifier();
 256         if (i != nullptr && i->getName() == id) {
 257             return ContextCheck(f->getDeclContext());
 258         }
 259     }
 260     return ContextCheck();
 261 }
 262
 263 ContextCheck DeclCheck::Var(llvm::StringRef id) const
 264 {
 265     auto f = llvm::dyn_cast_or_null<clang::VarDecl>(decl_);
 266     if (f != nullptr) {
 267         auto const i = f->getIdentifier();
 268         if (i != nullptr && i->getName() == id) {
 269             return ContextCheck(f->getDeclContext());
 270         }
 271     }
 272     return ContextCheck();
 273 }
 274
 275 ContextCheck ContextCheck::Namespace(llvm::StringRef id) const
 276 {
 277     if (context_) {
 278         auto n = llvm::dyn_cast<clang::NamespaceDecl>(context_);
 279         if (n != nullptr) {
 280             auto const i = n->getIdentifier();
 281             if (i != nullptr && i->getName() == id) {
 282                 return ContextCheck(n->getParent());
 283             }
 284         }
 285     }
 286     return ContextCheck();
 287 }
 288
 289 ContextCheck ContextCheck::Class(llvm::StringRef id) const
 290 {
 291     return detail::checkRecordDecl(
 292         llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Class, id);
 293 }
 294
 295 ContextCheck ContextCheck::Struct(llvm::StringRef id) const
 296 {
 297     return detail::checkRecordDecl(
 298         llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Struct, id);
 299 }
 300
 301 bool isExtraWarnUnusedType(clang::QualType type);
 302
 303 bool isOkToRemoveArithmeticCast(
 304     clang::ASTContext & context, clang::QualType t1, clang::QualType t2,
 305     const clang::Expr* subExpr);
 306
 307 }
 308
 309 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */