Changeset 173174 in webkit

Timestamp:

Sep 2, 2014 9:03:41 AM (10 years ago)

Author:

commit-queue@webkit.org

Message:

check-webkit-style should complain about C++ comments in Platform.h
​https://bugs.webkit.org/show_bug.cgi?id=133802

Patch by Renato Nagy <​rnagy@inf.u-szeged.hu> on 2014-09-02
Reviewed by Csaba Osztrogonác.

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

(check_platformh_comments):
(_process_lines):
(CppChecker):

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

(CppStyleTest.test_platformh_comment):

Location:

trunk/Tools

Files:

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

trunk/Tools/ChangeLog

@@ +1 @@
+2014-09-02  Renato Nagy  <rnagy@inf.u-szeged.hu>
+
+        check-webkit-style should complain about C++ comments in Platform.h
+        https://bugs.webkit.org/show_bug.cgi?id=133802
+
+        Reviewed by Csaba Osztrogonác.
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        (check_platformh_comments):
+        (_process_lines):
+        (CppChecker):
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+        (CppStyleTest.test_platformh_comment):
+
 2014-09-02  Brendan Long  <self@brendanlong.com>
 

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

@@ -3684 +3684 @@
 
 
+def check_platformh_comments(lines, error):
+    for line_number, line in enumerate(lines):
+        if line_number not in (0, len(lines) - 1):
+            if line.find("//") != -1:
+                error(line_number, 'build/cpp_comment', 5, 'CPP comments are not allowed in Platform.h, '
+                                                           'please use C comments /* ... */')
+
 def process_line(filename, file_extension,
                  clean_lines, line, include_state, function_state,
@@ -3766 +3773 @@
     if file_extension == 'h':
         check_for_header_guard(filename, lines, error)
+        if filename == 'Source/WTF/wtf/Platform.h':
+            check_platformh_comments(lines, error)
 
     remove_multi_line_comments(lines, error)
@@ -3812 +3821 @@
         'build/using_std',
         'build/using_namespace',
+        'build/cpp_comment',
         'legal/copyright',
         'readability/braces',

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

@@ -1141 +1141 @@
             2,  # One per line.
             error_collector.result_list().count(multiline_string_error_message))
+
+    def test_platformh_comments(self):
+        check_platformh_message = (
+            'CPP comments are not allowed in Platform.h, '
+            'please use C comments /* ... */  [build/cpp_comment] [5]')
+
+        platformh_file_path = 'Source/WTF/wtf/Platform.h'
+
+        # CPP comment are not allowed in Platform.h header file.
+        error_collector = ErrorCollector(self.assertTrue)
+        self.process_file_data(platformh_file_path, 'h',
+                               ['// This is a cpp comment.'],
+                               error_collector)
+        self.assertEqual(
+            1,
+            error_collector.result_list().count(check_platformh_message))
+
+        # C comments are allowed in Platform.h
+        error_collector = ErrorCollector(self.assertTrue)
+        self.process_file_data(platformh_file_path, 'h',
+                               ['/* This is a C comment.*/'],
+                               error_collector)
+        self.assertEqual(
+            0,
+            error_collector.result_list().count(check_platformh_message))
+
+        platformh_file_path = 'Source/WTF/wtf/platform.h'
+
+        # CPP comment are allowed in other header files.
+        error_collector = ErrorCollector(self.assertTrue)
+        self.process_file_data(platformh_file_path, 'h',
+                               ['// This is a cpp comment.'
+                                '// The filepath is not'
+                                '// Source/WTF/wtf/Platform.h'],
+                               error_collector)
+        self.assertEqual(
+            0,
+            error_collector.result_list().count(check_platformh_message))
 
     # Test non-explicit single-argument constructors