Changeset 83977 in webkit

Timestamp:

Apr 15, 2011 8:39:46 AM (13 years ago)

Author:

commit-queue@webkit.org

Message:

2011-04-15 Dmitry Lomov <​dslomov@google.com>

Reviewed by David Levin.

check-webkit-style shouldn't complain about not including a primary header file
if none exists
​https://bugs.webkit.org/show_bug.cgi?id=39514

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

Location:

trunk/Tools

Files:

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

trunk/Tools/ChangeLog

@@ +1 @@
+2011-04-15  Dmitry Lomov  <dslomov@google.com>
+
+        Reviewed by David Levin.
+
+        check-webkit-style shouldn't complain about not including a primary header file 
+        if none exists
+        https://bugs.webkit.org/show_bug.cgi?id=39514
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+
 2011-04-15  Eric Seidel  <eric@webkit.org>
 

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

@@ -313 +313 @@
         return self._visited_primary_section
 
-    def check_next_include_order(self, header_type, file_is_header):
+    def check_next_include_order(self, header_type, file_is_header, primary_header_exists):
         """Returns a non-empty error message if the next header is out of order.
 
@@ -358 +358 @@
             assert header_type == _OTHER_HEADER
             if not file_is_header and self._section < self._PRIMARY_SECTION:
-                error_message = before_error_message
+                if primary_header_exists:
+                    error_message = before_error_message
             self._section = self._OTHER_SECTION
 
@@ -2598 +2599 @@
 
 
+def _does_primary_header_exist(filename):
+    """Return a primary header file name for a file, or empty string
+    if the file is not source file or primary header does not exist.
+    """
+    fileinfo = FileInfo(filename)
+    if not fileinfo.is_source():
+        return False
+    primary_header = fileinfo.no_extension() + ".h"
+    return os.path.isfile(primary_header)
+
+
 def check_include_line(filename, file_extension, clean_lines, line_number, include_state, error):
     """Check rules that are applicable to #include lines.
@@ -2647 +2659 @@
 
     header_type = _classify_include(filename, include, is_system, include_state)
+    primary_header_exists = _does_primary_header_exist(filename)
     include_state.header_types[line_number] = header_type
 
@@ -2658 +2671 @@
     # The include_state object keeps track of the last type seen
     # and complains if the header types are out of order or missing.
-    error_message = include_state.check_next_include_order(header_type, file_extension == "h")
+    error_message = include_state.check_next_include_order(header_type,
+                                                           file_extension == "h",
+                                                           primary_header_exists)
 
     # Check to make sure we have a blank line after primary header.

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

@@ -2453 +2453 @@
         # Cheat os.path.abspath called in FileInfo class.
         self.os_path_abspath_orig = os.path.abspath
+        self.os_path_isfile_orig = os.path.isfile
         os.path.abspath = lambda value: value
 
     def tearDown(self):
         os.path.abspath = self.os_path_abspath_orig
+        os.path.isfile = self.os_path_isfile_orig
 
     def test_check_next_include_order__no_config(self):
         self.assertEqual('Header file should not contain WebCore config.h.',
-                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, True))
+                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, True, True))
 
     def test_check_next_include_order__no_self(self):
         self.assertEqual('Header file should not contain itself.',
-                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, True))
+                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, True, True))
         # Test actual code to make sure that header types are correctly assigned.
         self.assert_language_rules_check('Foo.h',
@@ -2476 +2478 @@
     def test_check_next_include_order__likely_then_config(self):
         self.assertEqual('Found header this file implements before WebCore config.h.',
-                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, False))
+                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, False, True))
         self.assertEqual('Found WebCore config.h after a header this file implements.',
-                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False))
+                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False, True))
 
     def test_check_next_include_order__other_then_config(self):
         self.assertEqual('Found other header before WebCore config.h.',
-                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, False))
+                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, False, True))
         self.assertEqual('Found WebCore config.h after other header.',
-                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False))
+                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False, True))
 
     def test_check_next_include_order__config_then_other_then_likely(self):
-        self.assertEqual('', self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False))
+        self.assertEqual('', self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False, True))
         self.assertEqual('Found other header before a header this file implements.',
-                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, False))
+                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, False, True))
         self.assertEqual('Found header this file implements after other header.',
-                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, False))
+                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, False, True))
 
     def test_check_alphabetical_include_order(self):
@@ -2586 +2588 @@
                                          '#include "g.h"\n',
                                          '"foo.h" already included at foo.cpp:2  [build/include] [4]')
+
+    def test_primary_header(self):
+        # File with non-existing primary header should not produce errors.
+        self.assert_language_rules_check('foo.cpp',
+                                         '#include "config.h"\n'
+                                         '\n'
+                                         '#include "bar.h"\n',
+                                         '')
+        # Pretend that header files exist.
+        os.path.isfile = lambda filename: True
+        # Missing include for existing primary header -> error.
+        self.assert_language_rules_check('foo.cpp',
+                                         '#include "config.h"\n'
+                                         '\n'
+                                         '#include "bar.h"\n',
+                                         'Found other header before a header this file implements. '
+                                         'Should be: config.h, primary header, blank line, and then '
+                                         'alphabetically sorted.  [build/include_order] [4]')
+        # Having include for existing primary header -> no error.
+        self.assert_language_rules_check('foo.cpp',
+                                         '#include "config.h"\n'
+                                         '#include "foo.h"\n'
+                                         '\n'
+                                         '#include "bar.h"\n',
+                                         '')
+
+        os.path.isfile = self.os_path_isfile_orig
+
 
     def test_check_wtf_includes(self):