maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[clang-tidy] Improve google-objc-function-naming diagnostics 📙 

Summary:
The diagnostics from google-objc-function-naming check will be more
actionable if they provide a brief description of the requirements from
the Google Objective-C style guide. The more descriptive diagnostics may
help clarify that functions in the global namespace must have an
appropriate prefix followed by Pascal case (engineers working previously
with static functions might not immediately understand the different
requirements of static and non-static functions).

Test Notes:
Verified against the clang-tidy tests.

Reviewers: benhamilton, aaron.ballman

Reviewed By: benhamilton

Subscribers: MyDeveloperDay, xazax.hun, cfe-commits

Differential Revision: https://reviews.llvm.org/D55482

llvm-svn: 349123
This commit is contained in:
Stephane Moore 2018-12-14 03:13:31 +00:00
parent 918adb56d8
commit b69ece899d
3 changed files with 33 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
clang-tools-extra/clang-tidy/google/FunctionNamingCheck.cpp
View File

@ -110,10 +110,12 @@ void FunctionNamingCheck::registerMatchers(MatchFinder *Finder) {
void FunctionNamingCheck::check(const MatchFinder::MatchResult &Result) { void FunctionNamingCheck::check(const MatchFinder::MatchResult &Result) {
const auto *MatchedDecl = Result.Nodes.getNodeAs<FunctionDecl>("function"); const auto *MatchedDecl = Result.Nodes.getNodeAs<FunctionDecl>("function");
bool IsGlobal = MatchedDecl->getStorageClass() != SC_Static;
diag(MatchedDecl->getLocation(), diag(MatchedDecl->getLocation(),
"function name %0 not using function naming conventions described by " "%select{static function|function in global namespace}1 named %0 must "
"Google Objective-C style guide") "%select{be in|have an appropriate prefix followed by}1 Pascal case as "
<< MatchedDecl << generateFixItHint(MatchedDecl); "required by Google Objective-C style guide")
<< MatchedDecl << IsGlobal << generateFixItHint(MatchedDecl);
} }
} // namespace objc } // namespace objc

27
clang-tools-extra/test/clang-tidy/google-objc-function-naming.m
View File

@ -3,28 +3,35 @@
typedef _Bool bool; typedef _Bool bool;
static bool ispositive(int a) { return a > 0; } static bool ispositive(int a) { return a > 0; }
// CHECK-MESSAGES: :[[@LINE-1]]:13: warning: function name 'ispositive' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:13: warning: static function named 'ispositive'
// must be in Pascal case as required by Google Objective-C style guide
// CHECK-FIXES: static bool Ispositive(int a) { return a > 0; } // CHECK-FIXES: static bool Ispositive(int a) { return a > 0; }
static bool is_positive(int a) { return a > 0; } static bool is_positive(int a) { return a > 0; }
// CHECK-MESSAGES: :[[@LINE-1]]:13: warning: function name 'is_positive' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:13: warning: static function named 'is_positive'
// must be in Pascal case as required by Google Objective-C style guide
// CHECK-FIXES: static bool IsPositive(int a) { return a > 0; } // CHECK-FIXES: static bool IsPositive(int a) { return a > 0; }
static bool isPositive(int a) { return a > 0; } static bool isPositive(int a) { return a > 0; }
// CHECK-MESSAGES: :[[@LINE-1]]:13: warning: function name 'isPositive' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:13: warning: static function named 'isPositive'
// must be in Pascal case as required by Google Objective-C style guide
// CHECK-FIXES: static bool IsPositive(int a) { return a > 0; } // CHECK-FIXES: static bool IsPositive(int a) { return a > 0; }
static bool Is_Positive(int a) { return a > 0; } static bool Is_Positive(int a) { return a > 0; }
// CHECK-MESSAGES: :[[@LINE-1]]:13: warning: function name 'Is_Positive' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:13: warning: static function named 'Is_Positive'
// must be in Pascal case as required by Google Objective-C style guide
// CHECK-FIXES: static bool IsPositive(int a) { return a > 0; } // CHECK-FIXES: static bool IsPositive(int a) { return a > 0; }
static bool IsPositive(int a) { return a > 0; } static bool IsPositive(int a) { return a > 0; }
bool ispalindrome(const char *str); bool ispalindrome(const char *str);
// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function name 'ispalindrome' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function in global namespace named
// 'ispalindrome' must have an appropriate prefix followed by Pascal case as
// required by Google Objective-C style guide
static const char *md5(const char *str) { return 0; } static const char *md5(const char *str) { return 0; }
// CHECK-MESSAGES: :[[@LINE-1]]:20: warning: function name 'md5' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:20: warning: static function named 'md5' must be
// in Pascal case as required by Google Objective-C style guide
// CHECK-FIXES: static const char *Md5(const char *str) { return 0; } // CHECK-FIXES: static const char *Md5(const char *str) { return 0; }
static const char *MD5(const char *str) { return 0; } static const char *MD5(const char *str) { return 0; }
@ -38,12 +45,16 @@ static const char *DEFFooURL(void) { return "https://clang.llvm.org/"; }
static const char *StringFromNSString(id str) { return ""; } static const char *StringFromNSString(id str) { return ""; }
void ABLog_String(const char *str); void ABLog_String(const char *str);
// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function name 'ABLog_String' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function in global namespace named
// 'ABLog_String' must have an appropriate prefix followed by Pascal case as
// required by Google Objective-C style guide
void ABLogString(const char *str); void ABLogString(const char *str);
bool IsPrime(int a); bool IsPrime(int a);
// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function name 'IsPrime' not using function naming conventions described by Google Objective-C style guide // CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function in global namespace named
// 'IsPrime' must have an appropriate prefix followed by Pascal case as required
// by Google Objective-C style guide
const char *ABURL(void) { return "https://clang.llvm.org/"; } const char *ABURL(void) { return "https://clang.llvm.org/"; }

15
clang-tools-extra/test/clang-tidy/google-objc-function-naming.mm
View File

@ -1,16 +1,19 @@
// RUN: %check_clang_tidy %s google-objc-function-naming %t // RUN: %check_clang_tidy %s google-objc-function-naming %t
void printSomething() {} void printSomething() {}
// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function name 'printSomething' not // CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function in global namespace named
// using function naming conventions described by Google Objective-C style guide // 'printSomething' must have an appropriate prefix followed by Pascal case as
// required by Google Objective-C style guide
void PrintSomething() {} void PrintSomething() {}
// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function name 'PrintSomething' not // CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function in global namespace named
// using function naming conventions described by Google Objective-C style guide // 'PrintSomething' must have an appropriate prefix followed by Pascal case as
// required by Google Objective-C style guide
void ABCBad_Name() {} void ABCBad_Name() {}
// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function name 'ABCBad_Name' not // CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function in global namespace named
// using function naming conventions described by Google Objective-C style guide // 'ABCBad_Name' must have an appropriate prefix followed by Pascal case as
// required by Google Objective-C style guide
namespace { namespace {