Changeset 160084 in webkit

Timestamp:

Dec 4, 2013 3:11:33 AM (10 years ago)

Author:

commit-queue@webkit.org

Message:

check-webkit-style should check member initialization indentation.
​https://bugs.webkit.org/show_bug.cgi?id=124820

Patch by László Langó <​lango@inf.u-szeged.hu> on 2013-12-04
Reviewed by Zoltan Herczeg.

check-webkit-style should check member initialization indentation
belongs to webkit coding style:
​http://www.webkit.org/coding/coding-style.html#punctuation-member-init

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

(check_member_initialization_list): Add new method to check member
initialization list.
(check_style): Add the call of the new method.
(check_language): Move self initialization checking into the new method.
(CppChecker): Add a new category for initialization list.

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

(CppStyleTest.test_runtime_selfinit):
(CppStyleTest.test_deprecated_cast):
(WebKitStyleTest.test_member_initialization_list): Add new testcases for
the new feature.

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/webkitpy/style/checkers/cpp.py (modified) (4 diffs)
• Scripts/webkitpy/style/checkers/cpp_unittest.py (modified) (3 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2013-12-04  László Langó  <lango@inf.u-szeged.hu>
+
+        check-webkit-style should check member initialization indentation.
+        https://bugs.webkit.org/show_bug.cgi?id=124820
+
+        Reviewed by Zoltan Herczeg.
+
+        check-webkit-style should check member initialization indentation
+        belongs to webkit coding style:
+        http://www.webkit.org/coding/coding-style.html#punctuation-member-init
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        (check_member_initialization_list): Add new method to check member
+        initialization list.
+        (check_style): Add the call of the new method.
+        (check_language): Move self initialization checking into the new method.
+        (CppChecker): Add a new category for initialization list.
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+        (CppStyleTest.test_runtime_selfinit):
+        (CppStyleTest.test_deprecated_cast):
+        (WebKitStyleTest.test_member_initialization_list): Add new testcases for
+        the new feature.
+
 2013-12-04  Tamas Gergely  <gertom@inf.u-szeged.hu>
 

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

@@ -1965 +1965 @@
 
 
+def check_member_initialization_list(clean_lines, line_number, error):
+    """ Look for style errors in member initialization list of classes.
+
+    Args:
+      clean_lines: A CleansedLines instance containing the file.
+      line_number: The number of the line to check.
+      error: The function to call with any errors found.
+    """
+
+    raw = clean_lines.raw_lines
+    line = raw[line_number]
+
+    if search(r'\b([A-Za-z0-9_]*_)\(\1\)', line):
+        error(line_number, 'runtime/init', 4,
+              'You seem to be initializing a member variable with itself.')
+
+    # Check the style of the initializer list.
+    # Each member (and superclass) should be indented on a separate line,
+    # with the colon or comma preceding the member on that line.
+    begin_line = line
+    if search(r'(?P<indentation>\s*)([^\s]\(.*\)\s?\:|^\s*\:).*[^;]*$', line):
+        if search(r'[^:]\:[^\:\s]+', line):
+            error(line_number, 'whitespace/init', 4,
+                'Missing spaces around :')
+        if search(r'[^\s]\(.*\)\s?\:.*[^;]*$', line):
+            error(line_number, 'whitespace/indent', 4,
+                'Should be indented on a separate line, with the colon or comma first on that line.')
+        else:
+            begin_line, begin_line_number = get_previous_non_blank_line(clean_lines, line_number)
+
+        matched = search(r'(?P<indentation>\s*).*', begin_line)
+        indentation = matched.group('indentation')
+        inner_indentation = indentation + ' ' * 4
+
+        while(not search(r'{', line)):
+            # Don't check inheritance style
+            if search(r'\S\(.*\)', line):
+                if not line.startswith(inner_indentation) and begin_line != line:
+                    error(line_number, 'whitespace/indent', 4,
+                        'Wrong number of spaces before statement. (expected: %d)' % len(inner_indentation))
+                if search(r'\S\s*,', line):
+                    error(line_number, 'whitespace/init', 4,
+                        'Comma should be at the beggining of the line in a member initialization list.')
+
+            # To avoid infinite loop, if can't find the end of member initialization list
+            if line_number < len(raw) - 1:
+                line_number = line_number + 1
+                line = raw[line_number]
+            else:
+                break
+
 def get_previous_non_blank_line(clean_lines, line_number):
     """Return the most recent non-blank line and its line number.
@@ -2640 +2691 @@
     check_exit_statement_simplifications(clean_lines, line_number, error)
     check_spacing(file_extension, clean_lines, line_number, error)
+    check_member_initialization_list(clean_lines, line_number, error)
     check_check(clean_lines, line_number, error)
     check_for_comparisons_to_zero(clean_lines, line_number, error)
@@ -2947 +2999 @@
               "hierarchy, use static_cast<> to upcast.  Google doesn't support "
               'RTTI.')
-
-    if search(r'\b([A-Za-z0-9_]*_)\(\1\)', line):
-        error(line_number, 'runtime/init', 4,
-              'You seem to be initializing a member variable with itself.')
 
     if file_extension == 'h':
@@ -3662 +3710 @@
         'whitespace/ending_newline',
         'whitespace/indent',
+        'whitespace/init',
         'whitespace/line_length',
         'whitespace/newline',

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

@@ -749 +749 @@
 
     def test_runtime_selfinit(self):
-        self.assert_lint(
-            'Foo::Foo(Bar r, Bel l) : r_(r_), l_(l_) { }',
+        self.assert_multi_line_lint(
+            '''\
+            Foo::Foo(Bar r, Bel l)
+                : r_(r_)
+                , l_(l_) { }''',
+            ['You seem to be initializing a member variable with itself.'
+            '  [runtime/init] [4]',
             'You seem to be initializing a member variable with itself.'
-            '  [runtime/init] [4]')
-        self.assert_lint(
-            'Foo::Foo(Bar r, Bel l) : r_(r), l_(l) { }',
-            '')
-        self.assert_lint(
-            'Foo::Foo(Bar r) : r_(r), l_(r_), ll_(l_) { }',
+            '  [runtime/init] [4]'])
+        self.assert_multi_line_lint(
+            '''\
+            Foo::Foo(Bar r, Bel l)
+                : r_(r)
+                , l_(l) { }''',
+            '')
+        self.assert_multi_line_lint(
+            '''\
+            Foo::Foo(Bar r)
+                : r_(r)
+                , l_(r_)
+                , ll_(l_) { }''',
             '')
 
@@ -819 +831 @@
             'int a = int(); // Constructor, o.k.',
             '')
-        self.assert_lint(
-            'X::X() : a(int()) { } // default Constructor, o.k.',
+        self.assert_multi_line_lint(
+            '''\
+            X::X()
+                : a(int()) { } // default Constructor, o.k.''',
             '')
         self.assert_lint(
@@ -4898 +4912 @@
                 webkit_export_error_rules))
 
+    def test_member_initialization_list(self):
+        self.assert_lint('MyClass::MyClass(Document* doc) : MySuperClass() { }',
+        'Should be indented on a separate line, with the colon or comma first on that line.'
+        '  [whitespace/indent] [4]')
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc) : MySuperClass()
+        { }''',
+        'Should be indented on a separate line, with the colon or comma first on that line.'
+        '  [whitespace/indent] [4]')
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc)
+        : MySuperClass()
+        { }''',
+        'Wrong number of spaces before statement. (expected: 12)'
+        '  [whitespace/indent] [4]')
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc) :
+            MySuperClass(),
+            m_doc(0)
+        { }''',
+        ['Should be indented on a separate line, with the colon or comma first on that line.'
+         '  [whitespace/indent] [4]',
+         'Comma should be at the beggining of the line in a member initialization list.'
+         '  [whitespace/init] [4]'])
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc) :MySuperClass()
+        { }''',
+        ['Missing spaces around :  [whitespace/init] [4]',
+         'Should be indented on a separate line, with the colon or comma first on that line.'
+         '  [whitespace/indent] [4]'])
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc):MySuperClass()
+        { }''',
+        ['Missing spaces around :  [whitespace/init] [4]',
+         'Should be indented on a separate line, with the colon or comma first on that line.'
+         '  [whitespace/indent] [4]'])
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc) : MySuperClass()
+        ,MySuperClass()
+        , m_doc(0)
+            , m_myMember(0)
+        { }''',
+        ['Should be indented on a separate line, with the colon or comma first on that line.'
+         '  [whitespace/indent] [4]',
+         'Wrong number of spaces before statement. (expected: 12)'
+         '  [whitespace/indent] [4]',
+         'Wrong number of spaces before statement. (expected: 12)'
+         '  [whitespace/indent] [4]',
+         'Missing space after ,  [whitespace/comma] [3]'])
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc)
+            :MySuperClass()
+        { }''',
+        'Missing spaces around :  [whitespace/init] [4]')
+        self.assert_multi_line_lint('''\
+        MyClass::MyClass(Document* doc)
+            : MySuperClass() , m_doc(0)
+        { }''',
+        'Comma should be at the beggining of the line in a member initialization list.'
+        '  [whitespace/init] [4]')
+        self.assert_multi_line_lint('''\
+        class MyClass : public Goo {
+        };''',
+        '')
+        self.assert_multi_line_lint('''\
+        class MyClass
+        : public Goo
+        , public foo {
+        };''',
+        '')
+
     def test_other(self):
         # FIXME: Implement this.