<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[180355] trunk/Tools</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/180355">180355</a></dd>
<dt>Author</dt> <dd>ddkilzer@apple.com</dd>
<dt>Date</dt> <dd>2015-02-19 12:06:46 -0800 (Thu, 19 Feb 2015)</dd>
</dl>

<h3>Log Message</h3>
<pre>check-webkit-style: do not warn about missing primary header for *SoftLink.cpp files
&lt;http://webkit.org/b/141799&gt;

Reviewed by Alex Christensen.

* Scripts/webkitpy/style/checkers/cpp.py:
(_IncludeState.check_next_include_order): Don't emit a warning
if the primary header exists and the source file name ends with
&quot;SoftLink.cpp&quot;.  Add 'filename' argument to method.
(check_include_line): Pass in 'filename'.

* Scripts/webkitpy/style/checkers/cpp_unittest.py:
(OrderOfIncludesTest.test_check_next_include_order__no_config):
(OrderOfIncludesTest.test_check_next_include_order__no_self):
(OrderOfIncludesTest.test_check_next_include_order__likely_then_config):
(OrderOfIncludesTest.test_check_next_include_order__other_then_config):
(OrderOfIncludesTest.test_check_next_include_order__config_then_other_then_likely):
- Add test filename arguments for calls to
  check_next_include_order().
(OrderOfIncludesTest.test_primary_header): Add test for a file
name ending in &quot;SoftLink.cpp&quot;.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptswebkitpystylecheckerscpppy">trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py</a></li>
<li><a href="#trunkToolsScriptswebkitpystylecheckerscpp_unittestpy">trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (180354 => 180355)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog        2015-02-19 19:48:12 UTC (rev 180354)
+++ trunk/Tools/ChangeLog        2015-02-19 20:06:46 UTC (rev 180355)
</span><span class="lines">@@ -1,3 +1,27 @@
</span><ins>+2015-02-19  David Kilzer  &lt;ddkilzer@apple.com&gt;
+
+        check-webkit-style: do not warn about missing primary header for *SoftLink.cpp files
+        &lt;http://webkit.org/b/141799&gt;
+
+        Reviewed by Alex Christensen.
+
+        * Scripts/webkitpy/style/checkers/cpp.py:
+        (_IncludeState.check_next_include_order): Don't emit a warning
+        if the primary header exists and the source file name ends with
+        &quot;SoftLink.cpp&quot;.  Add 'filename' argument to method.
+        (check_include_line): Pass in 'filename'.
+
+        * Scripts/webkitpy/style/checkers/cpp_unittest.py:
+        (OrderOfIncludesTest.test_check_next_include_order__no_config):
+        (OrderOfIncludesTest.test_check_next_include_order__no_self):
+        (OrderOfIncludesTest.test_check_next_include_order__likely_then_config):
+        (OrderOfIncludesTest.test_check_next_include_order__other_then_config):
+        (OrderOfIncludesTest.test_check_next_include_order__config_then_other_then_likely):
+        - Add test filename arguments for calls to
+          check_next_include_order().
+        (OrderOfIncludesTest.test_primary_header): Add test for a file
+        name ending in &quot;SoftLink.cpp&quot;.
+
</ins><span class="cx"> 2015-02-18  Enrica Casucci  &lt;enrica@apple.com&gt;
</span><span class="cx"> 
</span><span class="cx">         Add new tool to test editable Webviews.
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckerscpppy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py (180354 => 180355)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py        2015-02-19 19:48:12 UTC (rev 180354)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/cpp.py        2015-02-19 20:06:46 UTC (rev 180355)
</span><span class="lines">@@ -277,7 +277,7 @@
</span><span class="cx">     def visited_primary_section(self):
</span><span class="cx">         return self._visited_primary_section
</span><span class="cx"> 
</span><del>-    def check_next_include_order(self, header_type, file_is_header, primary_header_exists):
</del><ins>+    def check_next_include_order(self, header_type, filename, file_is_header, primary_header_exists):
</ins><span class="cx">         &quot;&quot;&quot;Returns a non-empty error message if the next header is out of order.
</span><span class="cx"> 
</span><span class="cx">         This function also updates the internal state to be ready to check
</span><span class="lines">@@ -285,7 +285,9 @@
</span><span class="cx"> 
</span><span class="cx">         Args:
</span><span class="cx">           header_type: One of the _XXX_HEADER constants defined above.
</span><ins>+          filename: The name of the current file.
</ins><span class="cx">           file_is_header: Whether the file that owns this _IncludeState is itself a header
</span><ins>+          primary_header_exists: Whether the primary header file actually exists on disk
</ins><span class="cx"> 
</span><span class="cx">         Returns:
</span><span class="cx">           The empty string if the header is in the right order, or an
</span><span class="lines">@@ -322,7 +324,7 @@
</span><span class="cx">         else:
</span><span class="cx">             assert header_type == _OTHER_HEADER
</span><span class="cx">             if not file_is_header and self._section &lt; self._PRIMARY_SECTION:
</span><del>-                if primary_header_exists:
</del><ins>+                if primary_header_exists and not filename.endswith('SoftLink.cpp'):
</ins><span class="cx">                     error_message = before_error_message
</span><span class="cx">             self._section = self._OTHER_SECTION
</span><span class="cx"> 
</span><span class="lines">@@ -2981,6 +2983,7 @@
</span><span class="cx">     # The include_state object keeps track of the last type seen
</span><span class="cx">     # and complains if the header types are out of order or missing.
</span><span class="cx">     error_message = include_state.check_next_include_order(header_type,
</span><ins>+                                                           filename,
</ins><span class="cx">                                                            file_extension == &quot;h&quot;,
</span><span class="cx">                                                            primary_header_exists)
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpystylecheckerscpp_unittestpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py (180354 => 180355)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py        2015-02-19 19:48:12 UTC (rev 180354)
+++ trunk/Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py        2015-02-19 20:06:46 UTC (rev 180355)
</span><span class="lines">@@ -2634,11 +2634,11 @@
</span><span class="cx"> 
</span><span class="cx">     def test_check_next_include_order__no_config(self):
</span><span class="cx">         self.assertEqual('Header file should not contain WebCore config.h.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, True, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, 'Foo.h', True, True))
</ins><span class="cx"> 
</span><span class="cx">     def test_check_next_include_order__no_self(self):
</span><span class="cx">         self.assertEqual('Header file should not contain itself.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, True, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, 'Foo.h', True, True))
</ins><span class="cx">         # Test actual code to make sure that header types are correctly assigned.
</span><span class="cx">         self.assert_language_rules_check('Foo.h',
</span><span class="cx">                                          '#include &quot;Foo.h&quot;\n',
</span><span class="lines">@@ -2650,22 +2650,22 @@
</span><span class="cx"> 
</span><span class="cx">     def test_check_next_include_order__likely_then_config(self):
</span><span class="cx">         self.assertEqual('Found header this file implements before WebCore config.h.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, False, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx">         self.assertEqual('Found WebCore config.h after a header this file implements.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx"> 
</span><span class="cx">     def test_check_next_include_order__other_then_config(self):
</span><span class="cx">         self.assertEqual('Found other header before WebCore config.h.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, False, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx">         self.assertEqual('Found WebCore config.h after other header.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx"> 
</span><span class="cx">     def test_check_next_include_order__config_then_other_then_likely(self):
</span><del>-        self.assertEqual('', self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, False, True))
</del><ins>+        self.assertEqual('', self.include_state.check_next_include_order(cpp_style._CONFIG_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx">         self.assertEqual('Found other header before a header this file implements.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, False, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._OTHER_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx">         self.assertEqual('Found header this file implements after other header.',
</span><del>-                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, False, True))
</del><ins>+                         self.include_state.check_next_include_order(cpp_style._PRIMARY_HEADER, 'Foo.cpp', False, True))
</ins><span class="cx"> 
</span><span class="cx">     def test_check_alphabetical_include_order(self):
</span><span class="cx">         self.assert_language_rules_check('foo.h',
</span><span class="lines">@@ -2818,6 +2818,12 @@
</span><span class="cx">                                          'Found other header before a header this file implements. '
</span><span class="cx">                                          'Should be: config.h, primary header, blank line, and then '
</span><span class="cx">                                          'alphabetically sorted.  [build/include_order] [4]')
</span><ins>+        # *SoftLink.cpp files should not include their headers -&gt; no error.
+        self.assert_language_rules_check('FooSoftLink.cpp',
+                                         '#include &quot;config.h&quot;\n'
+                                         '\n'
+                                         '#include &quot;SoftLinking.h&quot;\n',
+                                         '')
</ins><span class="cx">         # Having include for existing primary header -&gt; no error.
</span><span class="cx">         self.assert_language_rules_check('foo.cpp',
</span><span class="cx">                                          '#include &quot;config.h&quot;\n'
</span></span></pre>
</div>
</div>

</body>
</html>