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