This is an archive of the discontinued LLVM Phabricator instance.

Differential D51832

[clang-tidy/checks] Update objc-property-declaration check to allow arbitrary acronyms and initialisms 🔧
ClosedPublic

Authored by stephanemoore on Sep 8 2018, 12:04 PM.

Details

Reviewers
benhamilton
Wizard
Commits
rGaf4755aca8ad: [clang-tidy/checks] Update objc-property-declaration check to allow arbitrary…
rCTE348331: [clang-tidy/checks] Update objc-property-declaration check to allow arbitrary…
rL348331: [clang-tidy/checks] Update objc-property-declaration check to allow arbitrary…
Summary

§1 Description

This changes the objc-property-declaration check to allow arbitrary acronyms and initialisms instead of using whitelisted acronyms. In Objective-C it is relatively common to use project prefixes in property names for the purposes of disambiguation. For example, the CIColor¹ and CGColor² properties on UIColor both represent symbol prefixes being used in proeprty names outside of Apple's accepted acronyms³. The union of Apple's accepted acronyms and all symbol prefixes that might be used for disambiguation in property declarations effectively allows for any arbitrary sequence of capital alphanumeric characters to be acceptable in property declarations. This change updates the check accordingly.

The test variants with custom configurations are deleted as part of this change because their configurations no longer impact behavior. The acronym configurations are currently preserved for backwards compatibility of check configuration.

[1] https://developer.apple.com/documentation/uikit/uicolor/1621951-cicolor?language=objc
[2] https://developer.apple.com/documentation/uikit/uicolor/1621954-cgcolor?language=objc
[3] https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/APIAbbreviations.html#//apple_ref/doc/uid/20001285-BCIHCGAE

§2 Test Notes

Changes verified by:
• Running clang-tidy unit tests.
• Used check_clang_tidy.py to verify expected output of processing objc-property-declaration.m

Diff Detail

Repository
rL LLVM

Event Timeline

stephanemoore created this revision.Sep 8 2018, 12:04 PM
Herald added subscribers: cfe-commits, jfb. · View Herald TranscriptSep 8 2018, 12:04 PM
stephanemoore updated this revision to Diff 164582.Sep 8 2018, 10:04 PM

Fix a couple issues:
• Forward declare NSArray in objc-property-declaration.m.
• Remove unnecessary lightweight generics declaration from IDs property in objc-property-declaration.m to fix compilation error.

stephanemoore updated this revision to Diff 164583.Sep 8 2018, 10:06 PM

Sorted forward declared classes in objc-property-declaration.m.

benhamilton accepted this revision.Sep 10 2018, 8:16 AM

This is fine, but please update the comments (and docs?) to make it clear that we no longer enforce camelCase but allow aRBiTraRYcAsE now.

clang-tidy/objc/PropertyDeclarationCheck.cpp
28–31 ↗(On Diff #164583)

These comments are no longer accurate.

73–74 ↗(On Diff #164583)

Just to be clear, this also allows things like aRbITRaRyCapS, right? We should comment that this is explicitly by design.

113–115 ↗(On Diff #164583)

This comment is no longer accurate.

This revision is now accepted and ready to land.Sep 10 2018, 8:16 AM
stephanemoore updated this revision to Diff 172285.Nov 1 2018, 5:42 PM
stephanemoore marked an inline comment as done.

Updated comments, release notes, and documentation to be consistent with the implemented changes.

stephanemoore added a comment.Nov 1 2018, 5:50 PM

I believe that it should be safe to remove the Acronyms and IncludeDefaultAcronyms options but if it's alright with you, I would prefer to separate that into a followup change.

clang-tidy/objc/PropertyDeclarationCheck.cpp
28–31 ↗(On Diff #164583)

I think the comments are still more or less accurate? I think we have just changed the level of enforcement that we are applying.

We allow aRbITRaRyCapS now but that's based on the concession that it's fundamentally hard to identify appropriate lowerCamelCase with high precision (i.e., it is hard to reject "aRbITRaRyCapS" as a representation of "a rb IT ra ry cap S" without human judgment). I added a note that acronyms and initialisms are capitalized regardless of style though.

❧

Sidenote:
A spark of curiosity led to me realizing that the previous approach would also have allowed aRbITRaRyCapS if all letters of the alphabet were to be whitelisted as acronyms. The previous check already included several letters in the default special acronyms and provided special treatment for "A" and "I" in the matching regex. I can't say for certain that every letter of the alphabet would have ended up being whitelisted but I audited the letters of the alphabet and I think I managed to construct a list of terms that could conceivably have been used in code and might have led to the whitelisting of each individual letter of the alphabet (attached below¹).

[1] List of Letters in English Alphabet and Terms Containing Them in Isolation

stephanemoore added a comment.Dec 4 2018, 6:16 PM

Chatted with Ben offline and he's okay with proceeding.

stephanemoore updated this revision to Diff 176756.Dec 4 2018, 7:26 PM

Rebased changes and resolved merge conflicts.
Moved release notes update next to other release notes regarding updates to existing checks.

Wizard accepted this revision.Dec 4 2018, 7:38 PM
Closed by commit rL348331: [clang-tidy/checks] Update objc-property-declaration check to allow arbitrary… (authored by stephanemoore). · Explain WhyDec 4 2018, 7:46 PM
This revision was automatically updated to reflect the committed changes.
Herald added a subscriber: llvm-commits. · View Herald TranscriptDec 4 2018, 7:47 PM

Revision Contents

PathSize
clang-tools-extra/
trunk/
clang-tidy/
objc/
145 lines
docs/
4 lines
clang-tidy/
checks/
19 lines
test/
clang-tidy/
15 lines
18 lines
7 lines

Diff 176759

clang-tools-extra/trunk/clang-tidy/objc/PropertyDeclarationCheck.cpp

Show All 23 Lines
namespace objc { namespace objc {
namespace { namespace {
// For StandardProperty the naming style is 'lowerCamelCase'. // For StandardProperty the naming style is 'lowerCamelCase'.
// For CategoryProperty especially in categories of system class, // For CategoryProperty especially in categories of system class,
// to avoid naming conflict, the suggested naming style is // to avoid naming conflict, the suggested naming style is
// 'abc_lowerCamelCase' (adding lowercase prefix followed by '_'). // 'abc_lowerCamelCase' (adding lowercase prefix followed by '_').
// Regardless of the style, all acronyms and initialisms should be capitalized.
enum NamingStyle { enum NamingStyle {
StandardProperty = 1, StandardProperty = 1,
CategoryProperty = 2, CategoryProperty = 2,
}; };
/// The acronyms are aggregated from multiple sources including
/// https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/APIAbbreviations.html#//apple_ref/doc/uid/20001285-BCIHCGAE
///
/// Keep this list sorted.
constexpr llvm::StringLiteral DefaultSpecialAcronyms[] = {
"[2-9]G",
"ACL",
"API",
"APN",
"APNS",
"AR",
"ARGB",
"ASCII",
"AV",
"BGRA",
"CA",
"CDN",
"CF",
"CG",
"CI",
"CRC",
"CV",
"CMYK",
"DNS",
"FPS",
"FTP",
"GIF",
"GL",
"GPS",
"GUID",
"HD",
"HDR",
"HMAC",
"HTML",
"HTTP",
"HTTPS",
"HUD",
"ID",
"JPG",
"JS",
"JSON",
"LAN",
"LZW",
"LTR",
"MAC",
"MD",
"MDNS",
"MIDI",
"NS",
"OS",
"P2P",
"PDF",
"PIN",
"PNG",
"POI",
"PSTN",
"PTR",
"QA",
"QOS",
"RGB",
"RGBA",
"RGBX",
"RIPEMD",
"ROM",
"RPC",
"RTF",
"RTL",
"SC",
"SDK",
"SHA",
"SQL",
"SSO",
"TCP",
"TIFF",
"TOS",
"TTS",
"UI",
"URI",
"URL",
"UUID",
"VC",
"VO",
"VOIP",
"VPN",
"VR",
"W",
"WAN",
"X",
"XML",
"Y",
"Z",
};
/// For now we will only fix 'CamelCase' or 'abc_CamelCase' property to /// For now we will only fix 'CamelCase' or 'abc_CamelCase' property to
/// 'camelCase' or 'abc_camelCase'. For other cases the users need to /// 'camelCase' or 'abc_camelCase'. For other cases the users need to
/// come up with a proper name by their own. /// come up with a proper name by their own.
/// FIXME: provide fix for snake_case to snakeCase /// FIXME: provide fix for snake_case to snakeCase
FixItHint generateFixItHint(const ObjCPropertyDecl *Decl, NamingStyle Style) { FixItHint generateFixItHint(const ObjCPropertyDecl *Decl, NamingStyle Style) {
auto Name = Decl->getName(); auto Name = Decl->getName();
auto NewName = Decl->getName().str(); auto NewName = Decl->getName().str();
size_t Index = 0; size_t Index = 0;
if (Style == CategoryProperty) { if (Style == CategoryProperty) {
Index = Name.find_first_of('_') + 1; Index = Name.find_first_of('_') + 1;
NewName.replace(0, Index - 1, Name.substr(0, Index - 1).lower()); NewName.replace(0, Index - 1, Name.substr(0, Index - 1).lower());
} }
if (Index < Name.size()) { if (Index < Name.size()) {
NewName[Index] = tolower(NewName[Index]); NewName[Index] = tolower(NewName[Index]);
if (NewName != Name) { if (NewName != Name) {
return FixItHint::CreateReplacement( return FixItHint::CreateReplacement(
CharSourceRange::getTokenRange(SourceRange(Decl->getLocation())), CharSourceRange::getTokenRange(SourceRange(Decl->getLocation())),
llvm::StringRef(NewName)); llvm::StringRef(NewName));
} }
} }
return FixItHint(); return FixItHint();
} }
std::string AcronymsGroupRegex(llvm::ArrayRef<std::string> EscapedAcronyms) { std::string validPropertyNameRegex(bool UsedInMatcher) {
return "(" +
llvm::join(EscapedAcronyms.begin(), EscapedAcronyms.end(), "s?|") +
"s?)";
}
std::string validPropertyNameRegex(llvm::ArrayRef<std::string> EscapedAcronyms,
bool UsedInMatcher) {
// Allow any of these names: // Allow any of these names:
// foo // foo
// fooBar // fooBar
// url // url
// urlString // urlString
// ID
// IDs
// URL // URL
// URLString // URLString
// bundleID // bundleID
// CIColor
//
// Disallow names of this form:
// LongString
//
// aRbITRaRyCapS is allowed to avoid generating false positives for names
// like isVitaminBSupplement, CProgrammingLanguage, and isBeforeM.
std::string StartMatcher = UsedInMatcher ? "::" : "^"; std::string StartMatcher = UsedInMatcher ? "::" : "^";
std::string AcronymsMatcher = AcronymsGroupRegex(EscapedAcronyms); return StartMatcher + "([a-z]|[A-Z][A-Z0-9])[a-z0-9A-Z]*$";
return StartMatcher + "(" + AcronymsMatcher + "[A-Z]?)?[a-z]+[a-z0-9]*(" +
AcronymsMatcher + "|([A-Z][a-z0-9]+)|A|I)*$";
} }
bool hasCategoryPropertyPrefix(llvm::StringRef PropertyName) { bool hasCategoryPropertyPrefix(llvm::StringRef PropertyName) {
auto RegexExp = llvm::Regex("^[a-zA-Z]+_[a-zA-Z0-9][a-zA-Z0-9_]+$"); auto RegexExp = llvm::Regex("^[a-zA-Z]+_[a-zA-Z0-9][a-zA-Z0-9_]+$");
return RegexExp.match(PropertyName); return RegexExp.match(PropertyName);
} }
bool prefixedPropertyNameValid(llvm::StringRef PropertyName, bool prefixedPropertyNameValid(llvm::StringRef PropertyName) {
llvm::ArrayRef<std::string> Acronyms) {
size_t Start = PropertyName.find_first_of('_'); size_t Start = PropertyName.find_first_of('_');
assert(Start != llvm::StringRef::npos && Start + 1 < PropertyName.size()); assert(Start != llvm::StringRef::npos && Start + 1 < PropertyName.size());
auto Prefix = PropertyName.substr(0, Start); auto Prefix = PropertyName.substr(0, Start);
if (Prefix.lower() != Prefix) { if (Prefix.lower() != Prefix) {
return false; return false;
} }
auto RegexExp = auto RegexExp =
llvm::Regex(llvm::StringRef(validPropertyNameRegex(Acronyms, false))); llvm::Regex(llvm::StringRef(validPropertyNameRegex(false)));
return RegexExp.match(PropertyName.substr(Start + 1)); return RegexExp.match(PropertyName.substr(Start + 1));
} }
} // namespace } // namespace
PropertyDeclarationCheck::PropertyDeclarationCheck(StringRef Name, PropertyDeclarationCheck::PropertyDeclarationCheck(StringRef Name,
ClangTidyContext *Context) ClangTidyContext *Context)
: ClangTidyCheck(Name, Context), : ClangTidyCheck(Name, Context),
SpecialAcronyms( SpecialAcronyms(
utils::options::parseStringList(Options.get("Acronyms", ""))), utils::options::parseStringList(Options.get("Acronyms", ""))),
IncludeDefaultAcronyms(Options.get("IncludeDefaultAcronyms", true)), IncludeDefaultAcronyms(Options.get("IncludeDefaultAcronyms", true)),
EscapedAcronyms() {} EscapedAcronyms() {}
void PropertyDeclarationCheck::registerMatchers(MatchFinder *Finder) { void PropertyDeclarationCheck::registerMatchers(MatchFinder *Finder) {
// this check should only be applied to ObjC sources. // this check should only be applied to ObjC sources.
if (!getLangOpts().ObjC) return; if (!getLangOpts().ObjC) return;
if (IncludeDefaultAcronyms) {
EscapedAcronyms.reserve(llvm::array_lengthof(DefaultSpecialAcronyms) +
SpecialAcronyms.size());
// No need to regex-escape the default acronyms.
EscapedAcronyms.insert(EscapedAcronyms.end(),
std::begin(DefaultSpecialAcronyms),
std::end(DefaultSpecialAcronyms));
} else {
EscapedAcronyms.reserve(SpecialAcronyms.size());
}
// In case someone defines a prefix which includes a regex
// special character, regex-escape all the user-defined prefixes.
std::transform(SpecialAcronyms.begin(), SpecialAcronyms.end(),
std::back_inserter(EscapedAcronyms),
[](const std::string &s) { return llvm::Regex::escape(s); });
Finder->addMatcher( Finder->addMatcher(
objcPropertyDecl( objcPropertyDecl(
// the property name should be in Lower Camel Case like // the property name should be in Lower Camel Case like
// 'lowerCamelCase' // 'lowerCamelCase'
unless(matchesName(validPropertyNameRegex(EscapedAcronyms, true)))) unless(matchesName(validPropertyNameRegex(true))))
.bind("property"), .bind("property"),
this); this);
} }
void PropertyDeclarationCheck::check(const MatchFinder::MatchResult &Result) { void PropertyDeclarationCheck::check(const MatchFinder::MatchResult &Result) {
const auto *MatchedDecl = const auto *MatchedDecl =
Result.Nodes.getNodeAs<ObjCPropertyDecl>("property"); Result.Nodes.getNodeAs<ObjCPropertyDecl>("property");
assert(MatchedDecl->getName().size() > 0); assert(MatchedDecl->getName().size() > 0);
auto *DeclContext = MatchedDecl->getDeclContext(); auto *DeclContext = MatchedDecl->getDeclContext();
auto *CategoryDecl = llvm::dyn_cast<ObjCCategoryDecl>(DeclContext); auto *CategoryDecl = llvm::dyn_cast<ObjCCategoryDecl>(DeclContext);
auto SingleAcronymRegex =
llvm::Regex("^([a-zA-Z]+_)?" + AcronymsGroupRegex(EscapedAcronyms) + "$");
if (SingleAcronymRegex.match(MatchedDecl->getName())) {
return;
}
if (CategoryDecl != nullptr && if (CategoryDecl != nullptr &&
hasCategoryPropertyPrefix(MatchedDecl->getName())) { hasCategoryPropertyPrefix(MatchedDecl->getName())) {
if (!prefixedPropertyNameValid(MatchedDecl->getName(), EscapedAcronyms) || if (!prefixedPropertyNameValid(MatchedDecl->getName()) ||
CategoryDecl->IsClassExtension()) { CategoryDecl->IsClassExtension()) {
NamingStyle Style = CategoryDecl->IsClassExtension() ? StandardProperty NamingStyle Style = CategoryDecl->IsClassExtension() ? StandardProperty
: CategoryProperty; : CategoryProperty;
diag(MatchedDecl->getLocation(), diag(MatchedDecl->getLocation(),
"property name '%0' not using lowerCamelCase style or not prefixed " "property name '%0' not using lowerCamelCase style or not prefixed "
"in a category, according to the Apple Coding Guidelines") "in a category, according to the Apple Coding Guidelines")
<< MatchedDecl->getName() << generateFixItHint(MatchedDecl, Style); << MatchedDecl->getName() << generateFixItHint(MatchedDecl, Style);
} }
Show All 18 Lines

clang-tools-extra/trunk/docs/ReleaseNotes.rst

Show First 20 Lines • Show All 225 Lines • ▼ Show 20 Lines
- The :doc:`cppcoreguidelines-narrowing-conversions - The :doc:`cppcoreguidelines-narrowing-conversions
<clang-tidy/checks/cppcoreguidelines-narrowing-conversions>` check now <clang-tidy/checks/cppcoreguidelines-narrowing-conversions>` check now
detects more narrowing conversions: detects more narrowing conversions:
- integer to narrower signed integer (this is compiler implementation defined), - integer to narrower signed integer (this is compiler implementation defined),
- integer - floating point narrowing conversions, - integer - floating point narrowing conversions,
- floating point - integer narrowing conversions, - floating point - integer narrowing conversions,
- constants with narrowing conversions (even in ternary operator). - constants with narrowing conversions (even in ternary operator).
- The :doc:`objc-property-declaration
<clang-tidy/checks/objc-property-declaration>` check now ignores the
`Acronyms` and `IncludeDefaultAcronyms` options.
Improvements to include-fixer Improvements to include-fixer
----------------------------- -----------------------------
The improvements are... The improvements are...
Improvements to modularize Improvements to modularize
-------------------------- --------------------------
The improvements are... The improvements are...

clang-tools-extra/trunk/docs/clang-tidy/checks/objc-property-declaration.rst

Show First 20 Lines • Show All 41 Lines • ▼ Show 20 Lines
The corresponding style rule: https://developer.apple.com/library/content/qa/qa1908/_index.html The corresponding style rule: https://developer.apple.com/library/content/qa/qa1908/_index.html
Options Options
------- -------
.. option:: Acronyms .. option:: Acronyms
Semicolon-separated list of custom acronyms that can be used as a prefix This option is deprecated and ignored.
or a suffix of property names.
By default, appends to the list of default acronyms (
``IncludeDefaultAcronyms`` set to ``1``).
If ``IncludeDefaultAcronyms`` is set to ``0``, instead replaces the
default list of acronyms.
.. option:: IncludeDefaultAcronyms .. option:: IncludeDefaultAcronyms
Integer value (defaults to ``1``) to control whether the default This option is deprecated and ignored.
acronyms are included in the list of acronyms.
If set to ``1``, the value in ``Acronyms`` is appended to the
default list of acronyms:
``[2-9]G;ACL;API;APN;APNS;AR;ARGB;ASCII;AV;BGRA;CA;CDN;CF;CG;CI;CRC;CV;CMYK;DNS;FPS;FTP;GIF;GL;GPS;GUID;HD;HDR;HMAC;HTML;HTTP;HTTPS;HUD;ID;JPG;JS;JSON;LAN;LZW;LTR;MAC;MD;MDNS;MIDI;NS;OS;P2P;PDF;PIN;PNG;POI;PSTN;PTR;QA;QOS;RGB;RGBA;RGBX;RIPEMD;ROM;RPC;RTF;RTL;SC;SDK;SHA;SQL;SSO;TCP;TIFF;TOS;TTS;UI;URI;URL;UUID;VC;VO;VOIP;VPN;VR;W;WAN;X;XML;Y;Z``.
If set to ``0``, the value in ``Acronyms`` replaces the default list
of acronyms.

clang-tools-extra/trunk/test/clang-tidy/objc-property-declaration-additional.m

// 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' not using lowerCamelCase style or not prefixed in a category, 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' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@property(assign, nonatomic) int GIFShouldIncludeStandardAcronym;
@end

clang-tools-extra/trunk/test/clang-tidy/objc-property-declaration-custom.m

// RUN: %check_clang_tidy %s objc-property-declaration %t \
// RUN: -config='{CheckOptions: \
// RUN: [{key: objc-property-declaration.Acronyms, value: "ABC;TGIF"}, \
// RUN: {key: objc-property-declaration.IncludeDefaultAcronyms, value: 0}]}' \
// RUN: --
@class NSString;
@interface Foo
@property(assign, nonatomic) int AbcNotRealPrefix;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'AbcNotRealPrefix' not using lowerCamelCase style or not prefixed in a category, 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' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@property(assign, nonatomic) int GIFIgnoreStandardAcronym;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'GIFIgnoreStandardAcronym' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@property(strong, nonatomic) NSString *TGIF;
@end

clang-tools-extra/trunk/test/clang-tidy/objc-property-declaration.m

// RUN: %check_clang_tidy %s objc-property-declaration %t // RUN: %check_clang_tidy %s objc-property-declaration %t
@class CIColor;
@class NSArray;
@class NSData; @class NSData;
@class NSString; @class NSString;
@class UIViewController; @class UIViewController;
typedef void *CGColorRef;
@interface Foo @interface Foo
@property(assign, nonatomic) int NotCamelCase; @property(assign, nonatomic) int NotCamelCase;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
// CHECK-FIXES: @property(assign, nonatomic) int notCamelCase; // CHECK-FIXES: @property(assign, nonatomic) int notCamelCase;
@property(assign, nonatomic) int camelCase; @property(assign, nonatomic) int camelCase;
@property(strong, nonatomic) NSString *URLString; @property(strong, nonatomic) NSString *URLString;
@property(strong, nonatomic) NSString *bundleID; @property(strong, nonatomic) NSString *bundleID;
@property(strong, nonatomic) NSData *RGBABytes; @property(strong, nonatomic) NSData *RGBABytes;
@property(strong, nonatomic) UIViewController *notificationsVC; @property(strong, nonatomic) UIViewController *notificationsVC;
@property(strong, nonatomic) NSString *URL_string; @property(strong, nonatomic) NSString *URL_string;
// CHECK-MESSAGES: :[[@LINE-1]]:40: warning: property name 'URL_string' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:40: warning: property name 'URL_string' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@property(strong, nonatomic) NSString *supportURLsCamelCase; @property(strong, nonatomic) NSString *supportURLsCamelCase;
@property(strong, nonatomic) NSString *supportURLCamelCase; @property(strong, nonatomic) NSString *supportURLCamelCase;
@property(strong, nonatomic) NSString *VCsPluralToAdd; @property(strong, nonatomic) NSString *VCsPluralToAdd;
@property(assign, nonatomic) int centerX; @property(assign, nonatomic) int centerX;
@property(assign, nonatomic) int enable2GBackgroundFetch; @property(assign, nonatomic) int enable2GBackgroundFetch;
@property(assign, nonatomic) int shouldUseCFPreferences; @property(assign, nonatomic) int shouldUseCFPreferences;
@property(assign, nonatomic) int enableGLAcceleration; @property(assign, nonatomic) int enableGLAcceleration;
@property(assign, nonatomic) int ID; @property(assign, nonatomic) int ID;
@property(assign, nonatomic) int hasADog; @property(assign, nonatomic) int hasADog;
@property(nonatomic, readonly) CGColorRef CGColor;
@property(nonatomic, readonly) CIColor *CIColor;
@property(nonatomic, copy) NSArray *IDs;
@end @end
@interface Foo (Bar) @interface Foo (Bar)
@property(assign, nonatomic) int abc_NotCamelCase; @property(assign, nonatomic) int abc_NotCamelCase;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abc_NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abc_NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@property(assign, nonatomic) int abCD_camelCase; @property(assign, nonatomic) int abCD_camelCase;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abCD_camelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abCD_camelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
// CHECK-FIXES: @property(assign, nonatomic) int abcd_camelCase; // CHECK-FIXES: @property(assign, nonatomic) int abcd_camelCase;
@property(assign, nonatomic) int abCD_NotCamelCase; @property(assign, nonatomic) int abCD_NotCamelCase;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abCD_NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abCD_NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
// CHECK-FIXES: @property(assign, nonatomic) int abcd_notCamelCase; // CHECK-FIXES: @property(assign, nonatomic) int abcd_notCamelCase;
@property(assign, nonatomic) int wrongFormat_; @property(assign, nonatomic) int wrongFormat_;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'wrongFormat_' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'wrongFormat_' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@property(strong, nonatomic) NSString *URLStr; @property(strong, nonatomic) NSString *URLStr;
@property(assign, nonatomic) int abc_camelCase; @property(assign, nonatomic) int abc_camelCase;
@property(strong, nonatomic) NSString *abc_URL; @property(strong, nonatomic) NSString *abc_URL;
@end @end
@interface Foo () @interface Foo ()
@property(assign, nonatomic) int abc_inClassExtension; @property(assign, nonatomic) int abc_inClassExtension;
// CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abc_inClassExtension' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration] // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abc_inClassExtension' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
@end @end
No newline at end of file No newline at end of file
clang-tools-extra/trunk/docs/clang-tidy/checks/objc-property-declaration.rst