Changeset 156105 in webkit

Timestamp:

Sep 19, 2013, 11:13:19 AM (12 years ago)

Author:

mitz@apple.com

Message:

Add a style guideline regarding spacing in range-based for loops
​https://bugs.webkit.org/show_bug.cgi?id=121620

Reviewed by Anders Carlsson.

Tools:

• Scripts/webkitpy/style/checkers/cpp.py:

(check_spacing): Added checking that there are spaces around the colon in a range-based for
loop.
(CppChecker): Added whitespace/colon to the categories set.

• Scripts/webkitpy/style/checkers/cpp_unittest.py:

(WebKitStyleTest.test_spacing): Added two tests for the new check.

Websites/webkit.org:

• coding/coding-style.html: Added the guideline that spaces should be placed

around the colon in a range-based for loop.

Location:

trunk

Files:

• Tools/ChangeLog (modified) (1 diff)
• Tools/Scripts/webkitpy/style/checkers/cpp.py (modified) (2 diffs)
• Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py (modified) (2 diffs)
• Websites/webkit.org/ChangeLog (modified) (1 diff)
• Websites/webkit.org/coding/coding-style.html (modified) (1 diff)

trunk/Tools/ChangeLog

@@ +1 @@
+2013-09-19  Dan Bernstein  <mitz@apple.com>
+
+        Add a style guideline regarding spacing in range-based for loops
+        https://bugs.webkit.org/show_bug.cgi?id=121620
+
+        Reviewed by Anders Carlsson.
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        (check_spacing): Added checking that there are spaces around the colon in a range-based for
+        loop.
+        (CppChecker): Added whitespace/colon to the categories set.
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+        (WebKitStyleTest.test_spacing): Added two tests for the new check.
+
 2013-09-18  Sam Weinig  <sam@webkit.org>
 

trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py

@@ -1908 +1908 @@
         condition, rest = up_to_unmatched_closing_paren(matched.group('remainder'))
         if condition is not None:
+            if statement == 'for' and search(r'(?:[^ :]:[^:]|[^:]:[^ :])', condition):
+                error(line_number, 'whitespace/colon', 4, 'Missing space around : in range-based for statement')
             condition_match = search(r'(?P<leading>[ ]*)(?P<separator>.).*[^ ]+(?P<trailing>[ ]*)', condition)
             if condition_match:
@@ -3700 +3702 @@
         'whitespace/blank_line',
         'whitespace/braces',
+        'whitespace/colon',
         'whitespace/comma',
         'whitespace/comments',

trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py

@@ -3850 +3850 @@
         #     '')
 
-        # 3. Place spaces between control statements and their parentheses.
+        # 3. Place spaces around the colon in a range-based for loop.
+        self.assert_multi_line_lint(
+            '    for (const WTF::Vector& vector : vectors)\n'
+            '        process(vector);\n',
+            '')
+
+        self.assert_multi_line_lint(
+            '    for (const Vector& vector: vectors)\n'
+            '        process(vector);\n',
+            'Missing space around : in range-based for statement  [whitespace/colon] [4]')
+
+        # 5. Place spaces between control statements and their parentheses.
         self.assert_multi_line_lint(
             '    if (condition)\n'
@@ -3860 +3871 @@
             'Missing space before ( in if(  [whitespace/parens] [5]')
 
-        # 4. Do not place spaces between a function and its parentheses,
+        # 6. Do not place spaces between a function and its parentheses,
         #    or between a parenthesis and its content.
         self.assert_multi_line_lint(

trunk/Websites/webkit.org/ChangeLog

@@ +1 @@
+2013-09-19  Dan Bernstein  <mitz@apple.com>
+
+        Add a style guideline regarding spacing in range-based for loops
+        https://bugs.webkit.org/show_bug.cgi?id=121620
+
+        Reviewed by Anders Carlsson.
+
+        * coding/coding-style.html: Added the guideline that spaces should be placed
+        around the colon in a range-based for loop.
+
 2013-09-10  Beth Dakin  <bdakin@apple.com>
 

trunk/Websites/webkit.org/coding/coding-style.html

@@ -186 +186 @@
 c = a|b;
 return condition ? 1:0;
+</pre>
+</li>
+
+<li id="spacing-for-colon">Place spaces around the colon in a range-based for loop.
+<h4 class="right">Right:</h4>
+<pre class="code">
+Vector&lt;PluginModuleInfo> plugins;
+for (const auto&amp; plugin : plugins)
+    registerPlugin(plugin);
+</pre>
+
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+Vector&lt;PluginModuleInfo> plugins;
+for (const auto&amp; plugin: plugins)
+    registerPlugin(plugin);
 </pre>
 </li>