office-gobmx/compilerplugins/clang/check.hxx
Stephan Bergmann f4c126da92 Improved loplugin:staticanonymous -> redundantstatic
...now also covering variables with internal linkage that don't need a redundant
"static".  (Unlike with functions, with variables there are also cases that are
not in an unnamed namespace, hence the rename of the plugin.)

All the relevant changes across the code base have been done in the preceding
"Upcoming improved loplugin:staticanonymous -> redundantstatic" commits.
Ideally the changes would have been done with a rewriting plugin, but it can be
quite tedious in general to identify the correct occurrence of "static" that
must be removed, consider e.g.

  struct { int init() { static int n; return n++; } int x = init(); } static
  const a[10] = {};

However, it turned out that in all cases across the code base, the relevant
"static" was either at the start of the declaration or came after an initial
"const".  So I temporarily changed the plugin with

> --- a/compilerplugins/clang/redundantstatic.cxx
> +++ b/compilerplugins/clang/redundantstatic.cxx
> @@ -59,7 +59,7 @@ class RedundantStatic
>                  }
>                  report(
>                      DiagnosticsEngine::Warning, "redundant 'static' keyword in unnamed namespace",
> -                    decl->getLocation())
> +                    decl->getBeginLoc())
>                      << decl->getSourceRange();
>                  return true;
>              }
> @@ -73,7 +73,7 @@ class RedundantStatic
>                  DiagnosticsEngine::Warning,
>                  "non-inline variable of non-volatile const-qualified type is redundantly marked as"
>                      " 'static'",
> -                decl->getLocation())
> +                decl->getBeginLoc())
>                  << decl->getSourceRange();
>              return true;
>          }

to report the diagnostics at the start of the declarations (instead of at a more
natural place which is typically somewhere in the middle of the declaration),
compiled LO from within Emacs and then ran a function

> (defun doit ()
>   (interactive)
>   (while t
>     (next-error)
>     (with-current-buffer (window-buffer)
>       (when (re-search-forward
>              "\\=\\(\\<static\\>\\s *\\|\\(\\<const\\>\\)\\s +\\<static\\>\\)"
>              nil t)
>         (replace-match "\\2")))))

to do all the replacements.  (Plus solenv/clang-format/reformat-formatted-files
where necessary.)

Change-Id: Ie7efc8e0593a407c390a6a7a08c81e547410f18a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/97779
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2020-07-02 23:27:05 +02:00

312 lines
7.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_COMPILERPLUGINS_CLANG_CHECK_HXX
#define INCLUDED_COMPILERPLUGINS_CLANG_CHECK_HXX
#include <cstddef>
#include <clang/AST/DeclBase.h>
#include <clang/AST/Decl.h>
#include <clang/AST/Type.h>
#include <clang/Basic/OperatorKinds.h>
namespace loplugin {
class ContextCheck;
class TerminalCheck;
namespace detail {
inline ContextCheck checkRecordDecl(
clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id);
}
class DeclCheck;
class TypeCheck {
public:
explicit TypeCheck(clang::QualType type): type_(type) {}
explicit TypeCheck(clang::Type const * type): type_(type, 0) {}
explicit TypeCheck(clang::TypeDecl const * decl): type_(decl->getTypeForDecl(), 0) {}
explicit operator bool() const { return !type_.isNull(); }
TypeCheck NonConst() const;
TypeCheck NonConstVolatile() const;
TypeCheck Const() const;
TypeCheck Volatile() const;
TypeCheck ConstVolatile() const;
TypeCheck ConstNonVolatile() const;
TerminalCheck Void() const;
TerminalCheck Char() const;
TerminalCheck AnyBoolean() const;
TypeCheck Pointer() const;
TerminalCheck Enum() const;
TypeCheck LvalueReference() const;
inline ContextCheck Class(llvm::StringRef id) const;
inline ContextCheck Struct(llvm::StringRef id) const;
inline ContextCheck ClassOrStruct(llvm::StringRef id) const;
TypeCheck Typedef() const;
inline ContextCheck Typedef(llvm::StringRef id) const;
DeclCheck TemplateSpecializationClass() const;
TypeCheck NotSubstTemplateTypeParmType() const;
private:
TypeCheck() = default;
clang::QualType const type_{};
};
class DeclCheck {
friend TypeCheck;
public:
explicit DeclCheck(clang::Decl const * decl): decl_(decl) {}
explicit operator bool() const { return decl_ != nullptr; }
inline ContextCheck Class(llvm::StringRef id) const;
inline ContextCheck Struct(llvm::StringRef id) const;
inline ContextCheck ClassOrStruct(llvm::StringRef id) const;
inline ContextCheck Union(llvm::StringRef id) const;
inline ContextCheck Function(llvm::StringRef id) const;
ContextCheck Operator(clang::OverloadedOperatorKind op) const;
inline ContextCheck Var(llvm::StringRef id) const;
ContextCheck MemberFunction() const;
private:
DeclCheck() = default;
clang::Decl const * const decl_ = nullptr;
};
class ContextCheck {
public:
explicit ContextCheck(clang::DeclContext const * context = nullptr):
context_(context) {}
explicit operator bool() const { return context_ != nullptr; }
TerminalCheck GlobalNamespace() const;
inline ContextCheck Namespace(llvm::StringRef id) const;
TerminalCheck StdNamespace() const;
TerminalCheck StdOrNestedNamespace() const;
ContextCheck AnonymousNamespace() const;
inline ContextCheck Class(llvm::StringRef id) const;
inline ContextCheck Struct(llvm::StringRef id) const;
explicit ContextCheck(const clang::NamespaceDecl * decl ) : context_( decl ) {}
private:
clang::DeclContext const * const context_;
};
class TerminalCheck {
public:
explicit operator bool() const { return satisfied_; }
private:
friend ContextCheck;
friend TypeCheck;
explicit TerminalCheck(bool satisfied): satisfied_(satisfied) {}
bool const satisfied_;
};
typedef std::function<bool(clang::Decl const *)> DeclChecker;
// Returns true if the class has a base matching the checker, or if the class itself matches.
bool isDerivedFrom(const clang::CXXRecordDecl *decl, DeclChecker base);
namespace detail {
ContextCheck checkRecordDecl(
clang::Decl const * decl, clang::TagTypeKind tag, llvm::StringRef id)
{
auto r = llvm::dyn_cast_or_null<clang::RecordDecl>(decl);
if (r != nullptr && r->getTagKind() == tag) {
auto const i = r->getIdentifier();
if (i != nullptr && i->getName() == id) {
return ContextCheck(r->getDeclContext());
}
}
return ContextCheck();
}
}
ContextCheck TypeCheck::Class(llvm::StringRef id)
const
{
if (!type_.isNull()) {
auto const t = type_->getAs<clang::RecordType>();
if (t != nullptr) {
return detail::checkRecordDecl(t->getDecl(), clang::TTK_Class, id);
}
}
return ContextCheck();
}
ContextCheck TypeCheck::Struct(llvm::StringRef id) const
{
if (!type_.isNull()) {
auto const t = type_->getAs<clang::RecordType>();
if (t != nullptr) {
return detail::checkRecordDecl(t->getDecl(), clang::TTK_Struct, id);
}
}
return ContextCheck();
}
ContextCheck TypeCheck::ClassOrStruct(llvm::StringRef id) const
{
auto const c1 = Class(id);
if (c1) {
return c1;
}
return Struct(id);
}
ContextCheck TypeCheck::Typedef(llvm::StringRef id) const
{
if (!type_.isNull()) {
if (auto const t = type_->getAs<clang::TypedefType>()) {
auto const d = t->getDecl();
auto const i = d->getIdentifier();
assert(i != nullptr);
if (i->getName() == id) {
return ContextCheck(d->getDeclContext());
}
}
}
return ContextCheck();
}
ContextCheck DeclCheck::Class(llvm::StringRef id) const
{
return detail::checkRecordDecl(decl_, clang::TTK_Class, id);
}
ContextCheck DeclCheck::Struct(llvm::StringRef id) const
{
return detail::checkRecordDecl(decl_, clang::TTK_Struct, id);
}
ContextCheck DeclCheck::ClassOrStruct(llvm::StringRef id) const
{
auto const c1 = Class(id);
if (c1) {
return c1;
}
return Struct(id);
}
ContextCheck DeclCheck::Union(llvm::StringRef id) const
{
return detail::checkRecordDecl(decl_, clang::TTK_Union, id);
}
ContextCheck DeclCheck::Function(llvm::StringRef id) const
{
auto f = llvm::dyn_cast_or_null<clang::FunctionDecl>(decl_);
if (f != nullptr) {
auto const i = f->getIdentifier();
if (i != nullptr && i->getName() == id) {
return ContextCheck(f->getDeclContext());
}
}
return ContextCheck();
}
ContextCheck DeclCheck::Var(llvm::StringRef id) const
{
auto f = llvm::dyn_cast_or_null<clang::VarDecl>(decl_);
if (f != nullptr) {
auto const i = f->getIdentifier();
if (i != nullptr && i->getName() == id) {
return ContextCheck(f->getDeclContext());
}
}
return ContextCheck();
}
ContextCheck ContextCheck::Namespace(llvm::StringRef id) const
{
if (context_) {
auto n = llvm::dyn_cast<clang::NamespaceDecl>(context_);
if (n != nullptr) {
auto const i = n->getIdentifier();
if (i != nullptr && i->getName() == id) {
return ContextCheck(n->getParent());
}
}
}
return ContextCheck();
}
ContextCheck ContextCheck::Class(llvm::StringRef id) const
{
return detail::checkRecordDecl(
llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Class, id);
}
ContextCheck ContextCheck::Struct(llvm::StringRef id) const
{
return detail::checkRecordDecl(
llvm::dyn_cast_or_null<clang::Decl>(context_), clang::TTK_Struct, id);
}
bool isExtraWarnUnusedType(clang::QualType type);
bool isOkToRemoveArithmeticCast(
clang::ASTContext & context, clang::QualType t1, clang::QualType t2,
const clang::Expr* subExpr);
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */