Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add new check for property declaration
Summary: This check finds property declarations in Objective-C files that do not follow the pattern of property names in Apple's programming guide. The property name should be in the format of Lower Camel Case or with some particular acronyms as prefix. Example: @Property(nonatomic, assign) int lowerCamelCase; @Property(nonatomic, strong) NSString *URLString; Test plan: ninja check-clang-tools Reviewers: benhamilton, hokein Reviewed By: hokein Subscribers: cfe-commits, mgorny Differential Revision: https://reviews.llvm.org/D39829 llvm-svn: 318117
- Loading branch information
1 parent
08b34a0
commit 52161a5
Showing
10 changed files
with
247 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
115 changes: 115 additions & 0 deletions
115
clang-tools-extra/clang-tidy/objc/PropertyDeclarationCheck.cpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
//===--- PropertyDeclarationCheck.cpp - clang-tidy-------------------------===// | ||
// | ||
// The LLVM Compiler Infrastructure | ||
// | ||
// This file is distributed under the University of Illinois Open Source | ||
// License. See LICENSE.TXT for details. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#include "PropertyDeclarationCheck.h" | ||
#include "../utils/OptionsUtils.h" | ||
#include "clang/AST/ASTContext.h" | ||
#include "clang/ASTMatchers/ASTMatchFinder.h" | ||
#include "llvm/ADT/StringExtras.h" | ||
#include "llvm/Support/Regex.h" | ||
#include <algorithm> | ||
|
||
using namespace clang::ast_matchers; | ||
|
||
namespace clang { | ||
namespace tidy { | ||
namespace objc { | ||
|
||
namespace { | ||
/// The acronyms are from | ||
/// https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/APIAbbreviations.html#//apple_ref/doc/uid/20001285-BCIHCGAE | ||
constexpr char DefaultSpecialAcronyms[] = | ||
"ASCII;" | ||
"PDF;" | ||
"XML;" | ||
"HTML;" | ||
"URL;" | ||
"RTF;" | ||
"HTTP;" | ||
"TIFF;" | ||
"JPG;" | ||
"PNG;" | ||
"GIF;" | ||
"LZW;" | ||
"ROM;" | ||
"RGB;" | ||
"CMYK;" | ||
"MIDI;" | ||
"FTP"; | ||
|
||
/// For now we will only fix 'CamelCase' property to | ||
/// 'camelCase'. For other cases the users need to | ||
/// come up with a proper name by their own. | ||
/// FIXME: provide fix for snake_case to snakeCase | ||
FixItHint generateFixItHint(const ObjCPropertyDecl *Decl) { | ||
if (isupper(Decl->getName()[0])) { | ||
auto NewName = Decl->getName().str(); | ||
NewName[0] = tolower(NewName[0]); | ||
return FixItHint::CreateReplacement( | ||
CharSourceRange::getTokenRange(SourceRange(Decl->getLocation())), | ||
llvm::StringRef(NewName)); | ||
} | ||
return FixItHint(); | ||
} | ||
|
||
std::string validPropertyNameRegex(const std::vector<std::string> &Prefixes) { | ||
std::vector<std::string> EscapedPrefixes; | ||
EscapedPrefixes.reserve(Prefixes.size()); | ||
// In case someone defines a custom prefix which includes a regex | ||
// special character, escape all the prefixes. | ||
std::transform(Prefixes.begin(), Prefixes.end(), | ||
std::back_inserter(EscapedPrefixes), [](const std::string& s) { | ||
return llvm::Regex::escape(s); }); | ||
// Allow any of these names: | ||
// foo | ||
// fooBar | ||
// url | ||
// urlString | ||
// URL | ||
// URLString | ||
return std::string("::((") + | ||
llvm::join(EscapedPrefixes.begin(), EscapedPrefixes.end(), "|") + | ||
")[A-Z]?)?[a-z]+[a-z0-9]*([A-Z][a-z0-9]+)*$"; | ||
} | ||
} // namespace | ||
|
||
PropertyDeclarationCheck::PropertyDeclarationCheck(StringRef Name, | ||
ClangTidyContext *Context) | ||
: ClangTidyCheck(Name, Context), | ||
SpecialAcronyms(utils::options::parseStringList( | ||
Options.get("Acronyms", DefaultSpecialAcronyms))) {} | ||
|
||
void PropertyDeclarationCheck::registerMatchers(MatchFinder *Finder) { | ||
Finder->addMatcher( | ||
objcPropertyDecl( | ||
// the property name should be in Lower Camel Case like | ||
// 'lowerCamelCase' | ||
unless(matchesName(validPropertyNameRegex(SpecialAcronyms)))) | ||
.bind("property"), | ||
this); | ||
} | ||
|
||
void PropertyDeclarationCheck::check(const MatchFinder::MatchResult &Result) { | ||
const auto *MatchedDecl = | ||
Result.Nodes.getNodeAs<ObjCPropertyDecl>("property"); | ||
assert(MatchedDecl->getName().size() > 0); | ||
diag(MatchedDecl->getLocation(), | ||
"property name '%0' should use lowerCamelCase style, according to " | ||
"the Apple Coding Guidelines") | ||
<< MatchedDecl->getName() << generateFixItHint(MatchedDecl); | ||
} | ||
|
||
void PropertyDeclarationCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) { | ||
Options.store(Opts, "Acronyms", | ||
utils::options::serializeStringList(SpecialAcronyms)); | ||
} | ||
|
||
} // namespace objc | ||
} // namespace tidy | ||
} // namespace clang |
44 changes: 44 additions & 0 deletions
44
clang-tools-extra/clang-tidy/objc/PropertyDeclarationCheck.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
//===--- PropertyDeclarationCheck.h - clang-tidy-----------------*- C++ -*-===// | ||
// | ||
// The LLVM Compiler Infrastructure | ||
// | ||
// This file is distributed under the University of Illinois Open Source | ||
// License. See LICENSE.TXT for details. | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_PROPERTY_DECLARATION_H | ||
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_PROPERTY_DECLARATION_H | ||
|
||
#include "../ClangTidy.h" | ||
#include <string> | ||
#include <vector> | ||
|
||
namespace clang { | ||
namespace tidy { | ||
namespace objc { | ||
|
||
/// Finds Objective-C property declarations which | ||
/// are not in Lower Camel Case. | ||
/// | ||
/// The format of property should look like: | ||
/// @property(nonatomic) NSString *lowerCamelCase; | ||
/// | ||
/// For the user-facing documentation see: | ||
/// http://clang.llvm.org/extra/clang-tidy/checks/objc-property-declaration.html | ||
class PropertyDeclarationCheck : public ClangTidyCheck { | ||
public: | ||
PropertyDeclarationCheck(StringRef Name, ClangTidyContext *Context); | ||
void registerMatchers(ast_matchers::MatchFinder *Finder) override; | ||
void check(const ast_matchers::MatchFinder::MatchResult &Result) override; | ||
void storeOptions(ClangTidyOptions::OptionMap &Options) override; | ||
|
||
private: | ||
const std::vector<std::string> SpecialAcronyms; | ||
}; | ||
|
||
} // namespace objc | ||
} // namespace tidy | ||
} // namespace clang | ||
|
||
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_OBJC_PROPERTY_DECLARATION_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
clang-tools-extra/docs/clang-tidy/checks/objc-property-declaration.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
.. title:: clang-tidy - objc-property-declaration | ||
|
||
objc-property-declaration | ||
========================= | ||
|
||
Finds property declarations in Objective-C files that do not follow the pattern | ||
of property names in Apple's programming guide. The property name should be | ||
in the format of Lower Camel Case. | ||
|
||
For code: | ||
|
||
.. code-block:: objc | ||
@property(nonatomic, assign) int LowerCamelCase; | ||
|
||
The fix will be: | ||
|
||
.. code-block:: objc | ||
@property(nonatomic, assign) int lowerCamelCase; | ||
|
||
The check will only fix 'CamelCase' to 'camelCase'. In some other cases we will | ||
only provide warning messages since the property name could be complicated. | ||
Users will need to come up with a proper name by their own. | ||
|
||
This check also accepts special acronyms as prefix. Such prefix will suppress | ||
the check of Lower Camel Case according to the guide: | ||
https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/NamingBasics.html#//apple_ref/doc/uid/20001281-1002931-BBCFHEAB | ||
|
||
For a full list of well-known acronyms: | ||
https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/APIAbbreviations.html#//apple_ref/doc/uid/20001285-BCIHCGAE | ||
|
||
The corresponding style rule: https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/NamingIvarsAndTypes.html#//apple_ref/doc/uid/20001284-1001757 | ||
|
||
Options | ||
------- | ||
|
||
.. option:: Acronyms | ||
|
||
Semicolon-separated list of acronyms that can be used as prefix | ||
of property names. | ||
|
||
Defaults to ``ASCII;PDF;XML;HTML;URL;RTF;HTTP;TIFF;JPG;PNG;GIF;LZW;ROM;RGB;CMYK;MIDI;FTP``. |
14 changes: 14 additions & 0 deletions
14
clang-tools-extra/test/clang-tidy/objc-property-declaration-custom.m
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
// RUN: %check_clang_tidy %s objc-property-declaration %t \ | ||
// RUN: -config='{CheckOptions: \ | ||
// RUN: [{key: objc-property-declaration.Acronyms, value: "ABC;TGIF"}]}' \ | ||
// RUN: -- | ||
@class NSString; | ||
|
||
@interface Foo | ||
@property(assign, nonatomic) int AbcNotRealPrefix; | ||
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'AbcNotRealPrefix' should use lowerCamelCase style, according to the Apple Coding Guidelines [objc-property-declaration] | ||
// CHECK-FIXES: @property(assign, nonatomic) int abcNotRealPrefix; | ||
@property(assign, nonatomic) int ABCCustomPrefix; | ||
@property(strong, nonatomic) NSString *ABC_custom_prefix; | ||
// CHECK-MESSAGES: :[[@LINE-1]]:40: warning: property name 'ABC_custom_prefix' should use lowerCamelCase style, according to the Apple Coding Guidelines [objc-property-declaration] | ||
@end |
12 changes: 12 additions & 0 deletions
12
clang-tools-extra/test/clang-tidy/objc-property-declaration.m
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
// RUN: %check_clang_tidy %s objc-property-declaration %t | ||
@class NSString; | ||
|
||
@interface Foo | ||
@property(assign, nonatomic) int NotCamelCase; | ||
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'NotCamelCase' should use lowerCamelCase style, according to the Apple Coding Guidelines [objc-property-declaration] | ||
// CHECK-FIXES: @property(assign, nonatomic) int notCamelCase; | ||
@property(assign, nonatomic) int camelCase; | ||
@property(strong, nonatomic) NSString *URLString; | ||
@property(strong, nonatomic) NSString *URL_string; | ||
// CHECK-MESSAGES: :[[@LINE-1]]:40: warning: property name 'URL_string' should use lowerCamelCase style, according to the Apple Coding Guidelines [objc-property-declaration] | ||
@end |