This is an archive of the discontinued LLVM Phabricator instance.

Differential D42253

[clang-tidy objc-property-declaration] Expand list of ObjC acronyms
ClosedPublic

Authored by benhamilton on Jan 18 2018, 11:10 AM.

Details

Reviewers
Wizard
hokein
klimek
Commits
rG55c3a321a854: [clang-tidy objc-property-declaration] Expand list of ObjC acronyms
rCTE322886: [clang-tidy objc-property-declaration] Expand list of ObjC acronyms
rL322886: [clang-tidy objc-property-declaration] Expand list of ObjC acronyms
Summary

We were missing some pretty common acronyms in the camelCase
property name check objc-property-declaration.

This expands the list and sorts it lexicographically, so we can
avoid duplicates.

Test Plan: make -j12 check-clang-tools

Diff Detail

Event Timeline

benhamilton created this revision.Jan 18 2018, 11:10 AM
Herald added a subscriber: cfe-commits. · View Herald TranscriptJan 18 2018, 11:10 AM
Harbormaster completed remote builds in B13982: Diff 130459.Jan 18 2018, 11:12 AM
Wizard accepted this revision.Jan 18 2018, 11:35 AM
This revision is now accepted and ready to land.Jan 18 2018, 11:35 AM
Wizard added a comment.Jan 18 2018, 11:36 AM

Can you update the doc btw since the acronyms are not only for prefix anymore?

benhamilton updated this revision to Diff 130478.Jan 18 2018, 12:51 PM
  • Added comment about prefixes and suffixes.
  • Updated list of acronyms.
Harbormaster completed remote builds in B13988: Diff 130478.Jan 18 2018, 12:52 PM
Closed by commit rCTE322886: [clang-tidy objc-property-declaration] Expand list of ObjC acronyms (authored by benhamilton). · Explain WhyJan 18 2018, 12:53 PM
Closed by commit rL322886: [clang-tidy objc-property-declaration] Expand list of ObjC acronyms (authored by benhamilton). · Explain Why
This revision was automatically updated to reflect the committed changes.
This revision was automatically updated to reflect the committed changes.
Herald added a subscriber: llvm-commits. · View Herald TranscriptJan 18 2018, 12:53 PM

Revision Contents

PathSize
clang-tidy/
objc/
62 lines
test/
clang-tidy/
4 lines

Diff 130459

clang-tidy/objc/PropertyDeclarationCheck.cpp

Show All 18 Lines
namespace clang { namespace clang {
namespace tidy { namespace tidy {
namespace objc { namespace objc {
namespace { namespace {
/// The acronyms are from /// The acronyms are from
/// https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/APIAbbreviations.html#//apple_ref/doc/uid/20001285-BCIHCGAE /// https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/APIAbbreviations.html#//apple_ref/doc/uid/20001285-BCIHCGAE
///
/// Keep this list sorted.
constexpr char DefaultSpecialAcronyms[] = constexpr char DefaultSpecialAcronyms[] =
"ACL;"
"API;"
"ARGB;"
"ASCII;" "ASCII;"
"PDF;" "BGRA;"
"XML;" "CMYK;"
"DNS;"
"FPS;"
"FTP;"
"GIF;"
"GPS;"
"HD;"
"HDR;"
"HTML;" "HTML;"
"URL;"
"RTF;"
"HTTP;" "HTTP;"
"TIFF;" "HTTPS;"
"HUD;"
"ID;"
"JPG;" "JPG;"
"PNG;" "JS;"
"GIF;" "LAN;"
"LZW;" "LZW;"
"ROM;" "MDNS;"
"RGB;"
"CMYK;"
"MIDI;" "MIDI;"
"FTP;" "OS;"
"ID"; "PDF;"
"PIN;"
"PNG;"
"POI;"
"PSTN;"
"PTR;"
"QA;"
"QOS;"
"RGB;"
"RGBA;"
"RGBX;"
"ROM;"
"RPC;"
"RTF;"
"RTL;"
"SDK;"
"SSO;"
"TCP;"
"TIFF;"
"TTS;"
"UI;"
"URI;"
"URL;"
"VC;"
"VOIP;"
"VPN;"
"VR;"
"WAN;"
"XML";
/// For now we will only fix 'CamelCase' property to /// For now we will only fix 'CamelCase' property to
/// 'camelCase'. For other cases the users need to /// '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) { FixItHint generateFixItHint(const ObjCPropertyDecl *Decl) {
if (isupper(Decl->getName()[0])) { if (isupper(Decl->getName()[0])) {
auto NewName = Decl->getName().str(); auto NewName = Decl->getName().str();
▲ Show 20 Lines • Show All 65 Lines • Show Last 20 Lines

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 NSData;
@class NSString; @class NSString;
@class UIViewController;
@interface Foo @interface Foo
@property(assign, nonatomic) int NotCamelCase; @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-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; // 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) UIViewController *notificationsVC;
@property(strong, nonatomic) NSString *URL_string; @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] // CHECK-MESSAGES: :[[@LINE-1]]:40: warning: property name 'URL_string' should use lowerCamelCase style, according to the Apple Coding Guidelines [objc-property-declaration]
@end @end