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 #ifndef INCLUDED_COMPILERPLUGINS_CLANG_CHECK_HXX
  11 #define INCLUDED_COMPILERPLUGINS_CLANG_CHECK_HXX
  12
  13 #include <cstddef>
  14
  15 #include <clang/AST/DeclBase.h>
  16 #include <clang/AST/Decl.h>
  17 #include <clang/AST/Type.h>
  18 #include <clang/Basic/OperatorKinds.h>
  19
  20 namespace loplugin {
  21
  22 class ContextCheck;
  23 class TerminalCheck;
  24
  25 namespace detail {
  26
  27 inline ContextCheck checkRecordDecl(
  28     clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id);
  29
  30 }
  31
  32 class TypeCheck {
  33 public:
  34     explicit TypeCheck(clang::QualType type): type_(type) {}
  35
  36     explicit TypeCheck(clang::TypeDecl const * decl): type_(decl->getTypeForDecl(), 0) {}
  37
  38     explicit operator bool() const { return !type_.isNull(); }
  39
  40     TypeCheck NonConst() const;
  41
  42     TypeCheck NonConstVolatile() const;
  43
  44     TypeCheck Const() const;
  45
  46     TypeCheck Volatile() const;
  47
  48     TypeCheck ConstVolatile() const;
  49
  50     TerminalCheck Void() const;
  51
  52     TerminalCheck Char() const;
  53
  54     TerminalCheck AnyBoolean() const;
  55
  56     TypeCheck Pointer() const;
  57
  58     TerminalCheck Enum() const;
  59
  60     TypeCheck LvalueReference() const;
  61
  62     inline ContextCheck Class(llvm::StringRef id) const;
  63
  64     inline ContextCheck Struct(llvm::StringRef id) const;
  65
  66     TypeCheck Typedef() const;
  67
  68     inline ContextCheck Typedef(llvm::StringRef id) const;
  69
  70     TypeCheck NotSubstTemplateTypeParmType() const;
  71
  72 private:
  73     TypeCheck() = default;
  74
  75     clang::QualType const type_{};
  76 };
  77
  78 class DeclCheck {
  79 public:
  80     explicit DeclCheck(clang::Decl const * decl): decl_(decl) {}
  81
  82     explicit operator bool() const { return decl_ != nullptr; }
  83
  84     inline ContextCheck Class(llvm::StringRef id) const;
  85
  86     inline ContextCheck Struct(llvm::StringRef id) const;
  87
  88     inline ContextCheck Union(llvm::StringRef id) const;
  89
  90     inline ContextCheck Function(llvm::StringRef id) const;
  91
  92     ContextCheck Operator(clang::OverloadedOperatorKind op) const;
  93
  94     inline ContextCheck Var(llvm::StringRef id) const;
  95
  96     ContextCheck MemberFunction() const;
  97
  98 private:
  99     clang::Decl const * const decl_;
 100 };
 101
 102 class ContextCheck {
 103 public:
 104     explicit operator bool() const { return context_ != nullptr; }
 105
 106     TerminalCheck GlobalNamespace() const;
 107
 108     inline ContextCheck Namespace(llvm::StringRef id) const;
 109
 110     TerminalCheck StdNamespace() const;
 111
 112     ContextCheck AnonymousNamespace() const;
 113
 114     inline ContextCheck Class(llvm::StringRef id) const;
 115
 116     inline ContextCheck Struct(llvm::StringRef id) const;
 117
 118     explicit ContextCheck(const clang::NamespaceDecl * decl ) : context_( decl ) {}
 119
 120 private:
 121     friend DeclCheck;
 122     friend TypeCheck;
 123     friend ContextCheck detail::checkRecordDecl(
 124         clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id);
 125
 126     explicit ContextCheck(clang::DeclContext const * context = nullptr):
 127         context_(context) {}
 128
 129     clang::DeclContext const * const context_;
 130 };
 131
 132 class TerminalCheck {
 133 public:
 134     explicit operator bool() const { return satisfied_; }
 135
 136 private:
 137     friend ContextCheck;
 138     friend TypeCheck;
 139
 140     explicit TerminalCheck(bool satisfied): satisfied_(satisfied) {}
 141
 142     bool const satisfied_;
 143 };
 144
 145
 146 typedef std::function<bool(clang::Decl const *)> DeclChecker;
 147 // Returns true if the class has a base matching the checker, or if the class itself matches.
 148 bool isDerivedFrom(const clang::CXXRecordDecl *decl, DeclChecker base);
 149
 150
 151 namespace detail {
 152
 153 ContextCheck checkRecordDecl(
 154     clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id)
 155 {
 156     auto r = llvm::dyn_cast_or_null<clang::RecordDecl>(decl);
 157     if (r != nullptr && r->getTagKind() == tag) {
 158         auto const i = r->getIdentifier();
 159         if (i != nullptr && i->getName() == id) {
 160             return ContextCheck(r->getDeclContext());
 161         }
 162     }
 163     return ContextCheck();
 164 }
 165
 166 }
 167
 168 ContextCheck TypeCheck::Class(llvm::StringRef id)
 169     const
 170 {
 171     if (!type_.isNull()) {
 172         auto const t = type_->getAs<clang::RecordType>();
 173         if (t != nullptr) {
 174             return detail::checkRecordDecl(t->getDecl(), clang::TTK_Class, id);
 175         }
 176     }
 177     return ContextCheck();
 178 }
 179
 180 ContextCheck TypeCheck::Struct(llvm::StringRef id) const
 181 {
 182     if (!type_.isNull()) {
 183         auto const t = type_->getAs<clang::RecordType>();
 184         if (t != nullptr) {
 185             return detail::checkRecordDecl(t->getDecl(), clang::TTK_Struct, id);
 186         }
 187     }
 188     return ContextCheck();
 189 }
 190
 191 ContextCheck TypeCheck::Typedef(llvm::StringRef id) const
 192 {
 193     if (!type_.isNull()) {
 194         if (auto const t = type_->getAs<clang::TypedefType>()) {
 195             auto const d = t->getDecl();
 196             auto const i = d->getIdentifier();
 197             assert(i != nullptr);
 198             if (i->getName() == id) {
 199                 return ContextCheck(d->getDeclContext());
 200             }
 201         }
 202     }
 203     return ContextCheck();
 204 }
 205
 206 ContextCheck DeclCheck::Class(llvm::StringRef id) const
 207 {
 208     return detail::checkRecordDecl(decl_, clang::TTK_Class, id);
 209 }
 210
 211 ContextCheck DeclCheck::Struct(llvm::StringRef id) const
 212 {
 213     return detail::checkRecordDecl(decl_, clang::TTK_Struct, id);
 214 }
 215
 216 ContextCheck DeclCheck::Union(llvm::StringRef id) const
 217 {
 218     return detail::checkRecordDecl(decl_, clang::TTK_Union, id);
 219 }
 220
 221 ContextCheck DeclCheck::Function(llvm::StringRef id) const
 222 {
 223     auto f = llvm::dyn_cast_or_null<clang::FunctionDecl>(decl_);
 224     if (f != nullptr) {
 225         auto const i = f->getIdentifier();
 226         if (i != nullptr && i->getName() == id) {
 227             return ContextCheck(f->getDeclContext());
 228         }
 229     }
 230     return ContextCheck();
 231 }
 232
 233 ContextCheck DeclCheck::Var(llvm::StringRef id) const
 234 {
 235     auto f = llvm::dyn_cast_or_null<clang::VarDecl>(decl_);
 236     if (f != nullptr) {
 237         auto const i = f->getIdentifier();
 238         if (i != nullptr && i->getName() == id) {
 239             return ContextCheck(f->getDeclContext());
 240         }
 241     }
 242     return ContextCheck();
 243 }
 244
 245 ContextCheck ContextCheck::Namespace(llvm::StringRef id) const
 246 {
 247     if (context_) {
 248         auto n = llvm::dyn_cast<clang::NamespaceDecl>(context_);
 249         if (n != nullptr) {
 250             auto const i = n->getIdentifier();
 251             if (i != nullptr && i->getName() == id) {
 252                 return ContextCheck(n->getParent());
 253             }
 254         }
 255     }
 256     return ContextCheck();
 257 }
 258
 259 ContextCheck ContextCheck::Class(llvm::StringRef id) const
 260 {
 261     return detail::checkRecordDecl(
 262         llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Class, id);
 263 }
 264
 265 ContextCheck ContextCheck::Struct(llvm::StringRef id) const
 266 {
 267     return detail::checkRecordDecl(
 268         llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Struct, id);
 269 }
 270
 271 bool isExtraWarnUnusedType(clang::QualType type);
 272
 273 bool isOkToRemoveArithmeticCast(
 274     clang::ASTContext & context, clang::QualType t1, clang::QualType t2,
 275     const clang::Expr* subExpr);
 276
 277 }
 278
 279 #endif
 280
 281 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */