Extend protector naming code style guideline to cover operator= assignment.
authorbeidson@apple.com <beidson@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sat, 14 May 2016 04:45:42 +0000 (04:45 +0000)
committerbeidson@apple.com <beidson@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sat, 14 May 2016 04:45:42 +0000 (04:45 +0000)
https://bugs.webkit.org/show_bug.cgi?id=157693

Reviewed by Darin Adler.

Tools:

* Scripts/webkitpy/style/checkers/cpp.py:
(check_identifier_name_in_declaration):
* Scripts/webkitpy/style/checkers/cpp_unittest.py:
(WebKitStyleTest.test_names):

Websites/webkit.org:

* code-style.md:

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@200913 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Tools/ChangeLog
Tools/Scripts/webkitpy/style/checkers/cpp.py
Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py
Websites/webkit.org/ChangeLog
Websites/webkit.org/code-style.md

index b646d16a6c9e3c87d8aeccd49fb5e0b214a30f59..582ed6c8783488aead6e39efce496bad5c41fb4c 100644 (file)
@@ -1,3 +1,15 @@
+2016-05-13  Brady Eidson  <beidson@apple.com>
+
+        Extend protector naming code style guideline to cover operator= assignment.
+        https://bugs.webkit.org/show_bug.cgi?id=157693
+
+        Reviewed by Darin Adler.
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        (check_identifier_name_in_declaration):
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+        (WebKitStyleTest.test_names):
+
 2016-05-13  Aakash Jain  <aakash_jain@apple.com>
 
         Dashboard code restructuring
index 2a3af4e3496aa046b3b65f254e55d235d32e3816..9f1a358afc886be91fd0b23998125f8c898aec03 100644 (file)
@@ -3292,7 +3292,7 @@ def check_identifier_name_in_declaration(filename, line_number, line, file_state
         return
 
     # Make sure Ref/RefPtrs used as protectors are named correctly, and do this before we start stripping things off the input.
-    ref_regexp = r'^\s*Ref(Ptr)?<([\w_]|::)+> (?P<protector_name>[\w_]+)\((\*|&)*(m_)?(?P<protected_name>[\w_]+)\);'
+    ref_regexp = r'^\s*Ref(Ptr)?<([\w_]|::)+> (?P<protector_name>[\w_]+)(\(| = )(\*|&)*(m_)?(?P<protected_name>[\w_]+)\)?;'
     ref_check = match(ref_regexp, line)
     if ref_check:
         protector_name = ref_check.group('protector_name')
index e63a6a40d89f791755bb053f1da217e202604cd8..ee33eefa28c5c501e81d35d4da1db6eb2756bea9 100644 (file)
@@ -5204,10 +5204,23 @@ class WebKitStyleTest(CppStyleTestBase):
         self.assert_lint('Ref<Widget> protector(*m_widget);', '')
         self.assert_lint('RefPtr<SomeNamespace::Node> protectedThis(this);', '')
         self.assert_lint('RefPtr<SomeClass::InternalClass::Node> protectedThis(this);', '')
+        self.assert_lint('RefPtr<Node> protectedThis = this;', '')
+        self.assert_lint('Ref<Node> protectedThis = *this;', '')
+        self.assert_lint('RefPtr<Node> protectedNode = node;', '')
+        self.assert_lint('RefPtr<Node> protectedNode = &node;', '')
+        self.assert_lint('RefPtr<Node> protector = node;', '')
+        self.assert_lint('RefPtr<Node> protector = &node;', '')
+        self.assert_lint('Ref<Node> protectedNode = node;', '')
+        self.assert_lint('Ref<Node> protectedNode =*node;', '')
+        self.assert_lint('Ref<Node> protector = node;', '')
+        self.assert_lint('Ref<Node> protector = *node;', '')
+
 
         # Invalid protector RefPtr/Ref variable names.
         self.assert_lint('RefPtr<Node> protector(this);', "'protector' is incorrectly named. It should be named 'protectedThis'.  [readability/naming/protected] [4]")
         self.assert_lint('Ref<Node> protector(*this);', "'protector' is incorrectly named. It should be named 'protectedThis'.  [readability/naming/protected] [4]")
+        self.assert_lint('RefPtr<Node> protector = this;', "'protector' is incorrectly named. It should be named 'protectedThis'.  [readability/naming/protected] [4]")
+        self.assert_lint('Ref<Node> protector = *this;', "'protector' is incorrectly named. It should be named 'protectedThis'.  [readability/naming/protected] [4]")
         self.assert_lint('RefPtr<Node> self(this);', "'self' is incorrectly named. It should be named 'protectedThis'.  [readability/naming/protected] [4]")
         self.assert_lint('Ref<Node> self(*this);', "'self' is incorrectly named. It should be named 'protectedThis'.  [readability/naming/protected] [4]")
         self.assert_lint('RefPtr<Node> protectedThis(node);', "'protectedThis' is incorrectly named. It should be named 'protector' or 'protectedNode'.  [readability/naming/protected] [4]")
@@ -5218,6 +5231,10 @@ class WebKitStyleTest(CppStyleTestBase):
         self.assert_lint('RefPtr<Node> protectedNode(&otherNode);', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
         self.assert_lint('Ref<Node> protectedNode(otherNode);', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
         self.assert_lint('Ref<Node> protectedNode(*otherNode);', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
+        self.assert_lint('RefPtr<Node> protectedNode = otherNode;', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
+        self.assert_lint('RefPtr<Node> protectedNode = &otherNode;', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
+        self.assert_lint('Ref<Node> protectedNode = otherNode;', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
+        self.assert_lint('Ref<Node> protectedNode = *otherNode;', "'protectedNode' is incorrectly named. It should be named 'protector' or 'protectedOtherNode'.  [readability/naming/protected] [4]")
         self.assert_lint('RefPtr<Node> nodeRef(node);', "'nodeRef' is incorrectly named. It should be named 'protector' or 'protectedNode'.  [readability/naming/protected] [4]")
         self.assert_lint('Ref<Node> nodeRef(*node);', "'nodeRef' is incorrectly named. It should be named 'protector' or 'protectedNode'.  [readability/naming/protected] [4]")
 
index 24f03c5f45dbfd3cdb1360c0d11cc7befa8221b3..3ed48abd48a1615487f95668c693e1a2143e3c32 100644 (file)
@@ -1,3 +1,12 @@
+2016-05-13  Brady Eidson  <beidson@apple.com>
+
+        Extend protector naming code style guideline to cover operator= assignment.
+        https://bugs.webkit.org/show_bug.cgi?id=157693
+
+        Reviewed by Darin Adler.
+
+        * code-style.md:
+
 2016-05-13  Brady Eidson  <beidson@apple.com>
 
         Protector Ref/RefPtrs should have a specified naming style.
index 039ee43bf9ab28cc48960372aecebfe38301fba7..d8df8b958622a3799d4de6f5494cf8e625ab06e7 100644 (file)
@@ -720,12 +720,14 @@ setResizable(NotResizable);
 ```cpp
 RefPtr<Node> protectedThis(this);
 Ref<Element> protectedThis(*this);
+RefPtr<Widget> protectedThis = this;
 ```
 
 ###### Wrong:
 
 ```cpp
 RefPtr<Node> protector(this);
+Ref<Node> protector = *this;
 RefPtr<Widget> self(this);
 Ref<Element> elementRef(*this);
 ```
@@ -736,8 +738,10 @@ Ref<Element> elementRef(*this);
 
 ```cpp
 RefPtr<Element> protector(&element);
+RefPtr<Element> protector = &element;
 RefPtr<Node> protectedNode(node);
 RefPtr<Widget> protectedMainWidget(m_mainWidget);
+RefPtr<Loader> protectedFontLoader = m_fontLoader;
 ```
 
 ###### Wrong:
@@ -745,8 +749,8 @@ RefPtr<Widget> protectedMainWidget(m_mainWidget);
 ```cpp
 RefPtr<Node> nodeRef(&rootNode);
 Ref<Element> protect(*element);
-RefPtr<Widget> protected(widget);
 RefPtr<Node> protectorNode(node);
+RefPtr<Widget> protected = widget;
 ```
 
 ### Other Punctuation