Add support for ObjC property name to be a single acronym.

[Wizard]

Summary

This change will support cases like:

@property(assign, nonatomic) int ID;

[Wizard]

fix format

[benhamilton]

clang-tidy/objc/PropertyDeclarationCheck.cpp

161

s is a regular expression here, so you need to match it using llvm::Regex, not ==.

Why not just update validPropertyNameRegex() to handle this case?

test/clang-tidy/objc-property-declaration.m

24

Please add a test for a built-in regex (4G) as well as a custom regex in the other test file.

[Wizard]

clang-tidy/objc/PropertyDeclarationCheck.cpp

161

I would rather not to make the regex more complex as long as the change is simple and does bring extra cost. If update the regex it will be something like '(originalregex | acronyms)', which seems too much to me.

[Wizard]

resolve comments

[Wizard]

test/clang-tidy/objc-property-declaration.m

24

Unable to add single property test of 4G because it is illegal to use digit as the first character of property name.

[benhamilton]

clang-tidy/objc/PropertyDeclarationCheck.cpp

161

Please be aware this will change the match from running a single regular expression to running ~ 70 regular expressions on every single @property. I would expect this to perform pretty poorly.

test/clang-tidy/objc-property-declaration.m

24

Ah, of course.

[Wizard]

optimize matching

[Wizard]

clang-tidy/objc/PropertyDeclarationCheck.cpp

161

This is a good point. If using matching instead of equality check, I should not use any_of then. Updated it to use AcronymsGroupRegex().

[stephanemoore]

Looks good to me.

clang-tidy/objc/PropertyDeclarationCheck.cpp

enum NamingStyle {
   CategoryProperty = 2,
 };
 
 /// The acronyms are from
 /// 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",
-    "ARGB",
-    "ASCII",
-    "BGRA",
-    "CA",
-    "CF",
-    "CG",
-    "CI",
-    "CV",
-    "CMYK",
-    "DNS",
-    "FPS",
-    "FTP",
-    "GIF",
-    "GL",
-    "GPS",
-    "GUID",
-    "HD",
-    "HDR",
-    "HTML",
-    "HTTP",
-    "HTTPS",
-    "HUD",
-    "ID",
-    "JPG",
-    "JS",
-    "LAN",
-    "LZW",
-    "MDNS",
-    "MIDI",
-    "NS",
-    "OS",
-    "PDF",
-    "PIN",
-    "PNG",
-    "POI",
-    "PSTN",
-    "PTR",
-    "QA",
-    "QOS",
-    "RGB",
-    "RGBA",
-    "RGBX",
-    "ROM",
-    "RPC",
-    "RTF",
-    "RTL",
-    "SC",
-    "SDK",
-    "SSO",
-    "TCP",
-    "TIFF",
-    "TTS",
-    "UI",
-    "URI",
-    "URL",
-    "UUID",
-    "VC",
-    "VOIP",
-    "VPN",
-    "VR",
-    "W",
-    "WAN",
-    "X",
-    "XML",
-    "Y",
-    "Z",
+    "[2-9]G", "ACL", "API",  "ARGB", "ASCII", "BGRA",  "CA",   "CF",   "CG",
+    "CI",     "CV",  "CMYK", "DNS",  "FPS",   "FTP",   "GIF",  "GL",   "GPS",
+    "GUID",   "HD",  "HDR",  "HTML", "HTTP",  "HTTPS", "HUD",  "ID",   "JPG",
+    "JS",     "LAN", "LZW",  "MDNS", "MIDI",  "NS",    "OS",   "PDF",  "PIN",
+    "PNG",    "POI", "PSTN", "PTR",  "QA",    "QOS",   "RGB",  "RGBA", "RGBX",
+    "ROM",    "RPC", "RTF",  "RTL",  "SC",    "SDK",   "SSO",  "TCP",  "TIFF",
+    "TTS",    "UI",  "URI",  "URL",  "UUID",  "VC",    "VOIP", "VPN",  "VR",
+    "W",      "WAN", "X",    "XML",  "Y",     "Z",
 };
 
 /// For now we will only fix 'CamelCase' or 'abc_CamelCase' property to
 /// 'camelCase' or 'abc_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, NamingStyle Style) {
   auto Name = Decl->getName();

 }
 
 void PropertyDeclarationCheck::check(const MatchFinder::MatchResult &Result) {
   const auto *MatchedDecl =
       Result.Nodes.getNodeAs<ObjCPropertyDecl>("property");
   assert(MatchedDecl->getName().size() > 0);
   auto *DeclContext = MatchedDecl->getDeclContext();
   auto *CategoryDecl = llvm::dyn_cast<ObjCCategoryDecl>(DeclContext);
+  if (std::any_of(EscapedAcronyms.begin(), EscapedAcronyms.end(),
+                  [MatchedDecl](std::string const &s) {
+                    return s == MatchedDecl->getName();
+                  })) {
+    return;
+  }
   if (CategoryDecl != nullptr &&
       hasCategoryPropertyPrefix(MatchedDecl->getName())) {
     if (!prefixedPropertyNameValid(MatchedDecl->getName(), EscapedAcronyms) ||
         CategoryDecl->IsClassExtension()) {
       NamingStyle Style = CategoryDecl->IsClassExtension() ? StandardProperty
                                                            : CategoryProperty;
       diag(MatchedDecl->getLocation(),
            "property name '%0' not using lowerCamelCase style or not prefixed "

test/clang-tidy/objc-property-declaration.m

 // 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 *supportURLCamelCase;
 @property(strong, nonatomic) NSString *VCsPluralToAdd;
 @property(assign, nonatomic) int centerX;
 @property(assign, nonatomic) int enable2GBackgroundFetch;
 @property(assign, nonatomic) int shouldUseCFPreferences;
 @property(assign, nonatomic) int enableGLAcceleration;
+@property(assign, nonatomic) int ID;
 @end
 
 @interface Foo (Bar)
 @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]
 @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-FIXES: @property(assign, nonatomic) int abcd_camelCase;
 @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-FIXES: @property(assign, nonatomic) int abcd_notCamelCase;
 @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]
 @property(strong, nonatomic) NSString *URLStr;
 @property(assign, nonatomic) int abc_camelCase;
 @end
 
 @interface Foo ()
 @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]
 @end
 No newline at end of file