mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-19 11:35:51 -04:00
ec1982f07f
Summary: Revise the google-objc-global-variable-declaration check to match the style guide. This commit updates the check as follows: (1) Do not emit fixes for extern global constants. (2) Allow the second character of prefixes for constants to be numeric (the new guideline is that global constants should generally be named with a prefix that begins with a capital letter followed by one or more capital letters or numbers). https://google.github.io/styleguide/objcguide.html#prefixes This is an amended re-submission of https://reviews.llvm.org/rG12e3726fadb0b2a4d8aeed0a2817b5159f9d029d. Contributed By: yaqiji Reviewers: Wizard, benhamilton, stephanemoore Reviewed By: benhamilton, stephanemoore Subscribers: mgorny, cfe-commits, yaqiji Tags: #clang Differential Revision: https://reviews.llvm.org/D62045 llvm-svn: 362279
109 lines
3.8 KiB
C++
109 lines
3.8 KiB
C++
//===--- GlobalVariableDeclarationCheck.cpp - clang-tidy-------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "GlobalVariableDeclarationCheck.h"
|
|
#include "clang/AST/ASTContext.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "llvm/ADT/StringExtras.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
|
|
#include <string>
|
|
|
|
using namespace clang::ast_matchers;
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace google {
|
|
namespace objc {
|
|
|
|
namespace {
|
|
|
|
AST_MATCHER(VarDecl, isLocalVariable) { return Node.isLocalVarDecl(); }
|
|
|
|
FixItHint generateFixItHint(const VarDecl *Decl, bool IsConst) {
|
|
if (IsConst && (Decl->getStorageClass() != SC_Static)) {
|
|
// No fix available if it is not a static constant, since it is difficult
|
|
// to determine the proper fix in this case.
|
|
return FixItHint();
|
|
}
|
|
|
|
char FC = Decl->getName()[0];
|
|
if (!llvm::isAlpha(FC) || Decl->getName().size() == 1) {
|
|
// No fix available if first character is not alphabetical character, or it
|
|
// is a single-character variable, since it is difficult to determine the
|
|
// proper fix in this case. Users should create a proper variable name by
|
|
// their own.
|
|
return FixItHint();
|
|
}
|
|
char SC = Decl->getName()[1];
|
|
if ((FC == 'k' || FC == 'g') && !llvm::isAlpha(SC)) {
|
|
// No fix available if the prefix is correct but the second character is
|
|
// not alphabetical, since it is difficult to determine the proper fix in
|
|
// this case.
|
|
return FixItHint();
|
|
}
|
|
|
|
auto NewName = (IsConst ? "k" : "g") +
|
|
llvm::StringRef(std::string(1, FC)).upper() +
|
|
Decl->getName().substr(1).str();
|
|
|
|
return FixItHint::CreateReplacement(
|
|
CharSourceRange::getTokenRange(SourceRange(Decl->getLocation())),
|
|
llvm::StringRef(NewName));
|
|
}
|
|
} // namespace
|
|
|
|
void GlobalVariableDeclarationCheck::registerMatchers(MatchFinder *Finder) {
|
|
// The relevant Style Guide rule only applies to Objective-C.
|
|
if (!getLangOpts().ObjC)
|
|
return;
|
|
|
|
// need to add two matchers since we need to bind different ids to distinguish
|
|
// constants and variables. Since bind() can only be called on node matchers,
|
|
// we cannot make it in one matcher.
|
|
//
|
|
// Note that hasGlobalStorage() matches static variables declared locally
|
|
// inside a function or method, so we need to exclude those with
|
|
// isLocalVariable().
|
|
Finder->addMatcher(
|
|
varDecl(hasGlobalStorage(), unless(hasType(isConstQualified())),
|
|
unless(isLocalVariable()), unless(matchesName("::g[A-Z]")))
|
|
.bind("global_var"),
|
|
this);
|
|
Finder->addMatcher(varDecl(hasGlobalStorage(), hasType(isConstQualified()),
|
|
unless(isLocalVariable()),
|
|
unless(matchesName("::(k[A-Z])|([A-Z][A-Z0-9])")))
|
|
.bind("global_const"),
|
|
this);
|
|
}
|
|
|
|
void GlobalVariableDeclarationCheck::check(
|
|
const MatchFinder::MatchResult &Result) {
|
|
if (const auto *Decl = Result.Nodes.getNodeAs<VarDecl>("global_var")) {
|
|
if (Decl->isStaticDataMember())
|
|
return;
|
|
diag(Decl->getLocation(),
|
|
"non-const global variable '%0' must have a name which starts with "
|
|
"'g[A-Z]'")
|
|
<< Decl->getName() << generateFixItHint(Decl, false);
|
|
}
|
|
if (const auto *Decl = Result.Nodes.getNodeAs<VarDecl>("global_const")) {
|
|
if (Decl->isStaticDataMember())
|
|
return;
|
|
diag(Decl->getLocation(),
|
|
"const global variable '%0' must have a name which starts with "
|
|
"an appropriate prefix")
|
|
<< Decl->getName() << generateFixItHint(Decl, true);
|
|
}
|
|
}
|
|
|
|
} // namespace objc
|
|
} // namespace google
|
|
} // namespace tidy
|
|
} // namespace clang
|