<!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>[46230] trunk/WebKitTools</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/46230">46230</a></dd>
<dt>Author</dt> <dd>treat@webkit.org</dd>
<dt>Date</dt> <dd>2009-07-22 12:24:13 -0700 (Wed, 22 Jul 2009)</dd>
</dl>

<h3>Log Message</h3>
<pre>2009-07-22  Jakob Petsovits  &lt;jakob.petsovits@torchmobile.com&gt;

        Reviewed by Adam Treat.

        cpplint generates false positives for primary includes
        https://bugs.webkit.org/show_bug.cgi?id=27544

        Fix false positives for instances when cpplint would
        normally classify multiple includes as primary: After
        the first primary include, classify subsequent ones as
        &quot;other&quot; includes even if they look like primary ones.

        * Scripts/modules/cpplint.py:
        * Scripts/modules/cpplint_unittest.py:</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkWebKitToolsChangeLog">trunk/WebKitTools/ChangeLog</a></li>
<li><a href="#trunkWebKitToolsScriptsmodulescpplintpy">trunk/WebKitTools/Scripts/modules/cpplint.py</a></li>
<li><a href="#trunkWebKitToolsScriptsmodulescpplint_unittestpy">trunk/WebKitTools/Scripts/modules/cpplint_unittest.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkWebKitToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/WebKitTools/ChangeLog (46229 => 46230)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitTools/ChangeLog        2009-07-22 18:55:05 UTC (rev 46229)
+++ trunk/WebKitTools/ChangeLog        2009-07-22 19:24:13 UTC (rev 46230)
</span><span class="lines">@@ -1,3 +1,18 @@
</span><ins>+2009-07-22  Jakob Petsovits  &lt;jakob.petsovits@torchmobile.com&gt;
+
+        Reviewed by Adam Treat.
+
+        cpplint generates false positives for primary includes
+        https://bugs.webkit.org/show_bug.cgi?id=27544
+
+        Fix false positives for instances when cpplint would
+        normally classify multiple includes as primary: After
+        the first primary include, classify subsequent ones as
+        &quot;other&quot; includes even if they look like primary ones.
+
+        * Scripts/modules/cpplint.py:
+        * Scripts/modules/cpplint_unittest.py:
+
</ins><span class="cx"> 2009-07-22  Gabor Rapcsanyi  &lt;rapcsanyi.gabor@stud.u-szeged.hu&gt;
</span><span class="cx"> 
</span><span class="cx">         Reviewed by Simon Hausmann.
</span></span></pre></div>
<a id="trunkWebKitToolsScriptsmodulescpplintpy"></a>
<div class="modfile"><h4>Modified: trunk/WebKitTools/Scripts/modules/cpplint.py (46229 => 46230)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitTools/Scripts/modules/cpplint.py        2009-07-22 18:55:05 UTC (rev 46229)
+++ trunk/WebKitTools/Scripts/modules/cpplint.py        2009-07-22 19:24:13 UTC (rev 46230)
</span><span class="lines">@@ -291,7 +291,12 @@
</span><span class="cx">     def __init__(self):
</span><span class="cx">         dict.__init__(self)
</span><span class="cx">         self._section = self._INITIAL_SECTION
</span><ins>+        self._visited_primary_section = False
+        self.header_types = dict();
</ins><span class="cx"> 
</span><ins>+    def visited_primary_section(self):
+        return self._visited_primary_section
+
</ins><span class="cx">     def check_next_include_order(self, header_type, file_is_header):
</span><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="lines">@@ -331,6 +336,7 @@
</span><span class="cx">             elif self._section &lt; self._CONFIG_SECTION:
</span><span class="cx">                 error_message = before_error_message
</span><span class="cx">             self._section = self._PRIMARY_SECTION
</span><ins>+            self._visited_primary_section = True
</ins><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><span class="lines">@@ -2104,13 +2110,14 @@
</span><span class="cx">     return False
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-def _classify_include(filename, include, is_system):
</del><ins>+def _classify_include(filename, include, is_system, include_state):
</ins><span class="cx">     &quot;&quot;&quot;Figures out what kind of header 'include' is.
</span><span class="cx"> 
</span><span class="cx">     Args:
</span><span class="cx">       filename: The current file cpplint is running over.
</span><span class="cx">       include: The path to a #included file.
</span><span class="cx">       is_system: True if the #include used &lt;&gt; rather than &quot;&quot;.
</span><ins>+      include_state: An _IncludeState instance in which the headers are inserted.
</ins><span class="cx"> 
</span><span class="cx">     Returns:
</span><span class="cx">       One of the _XXX_HEADER constants.
</span><span class="lines">@@ -2137,8 +2144,14 @@
</span><span class="cx">     target_base = FileInfo(filename).base_name()
</span><span class="cx">     include_base = FileInfo(include).base_name()
</span><span class="cx"> 
</span><del>-    if target_base.startswith(include_base):
</del><ins>+    # If we haven't encountered a primary header, then be lenient in checking.
+    if not include_state.visited_primary_section() and target_base.startswith(include_base):
</ins><span class="cx">         return _PRIMARY_HEADER
</span><ins>+    # If we already encountered a primary header, perform a strict comparison.
+    # In case the two filename bases are the same then the above lenient check
+    # probably was a false positive.
+    elif include_state.visited_primary_section() and target_base == include_base:
+        return _PRIMARY_HEADER
</ins><span class="cx"> 
</span><span class="cx">     return _OTHER_HEADER
</span><span class="cx"> 
</span><span class="lines">@@ -2183,8 +2196,9 @@
</span><span class="cx">             # using a number of techniques. The include_state object keeps
</span><span class="cx">             # track of the highest type seen, and complains if we see a
</span><span class="cx">             # lower type after that.
</span><del>-            header_type = _classify_include(filename, include, is_system)
</del><ins>+            header_type = _classify_include(filename, include, is_system, include_state)
</ins><span class="cx">             error_message = include_state.check_next_include_order(header_type, filename.endswith('.h'))
</span><ins>+            include_state.header_types[line_number] = header_type
</ins><span class="cx"> 
</span><span class="cx">             # Check to make sure we have a blank line after primary header.
</span><span class="cx">             if not error_message and header_type == _PRIMARY_HEADER:
</span><span class="lines">@@ -2205,8 +2219,7 @@
</span><span class="cx">                     previous_line = clean_lines.lines[previous_line_number]
</span><span class="cx">                     previous_match = _RE_PATTERN_INCLUDE.search(previous_line)
</span><span class="cx">                  if previous_match:
</span><del>-                    previous_include = previous_match.group(2)
-                    previous_header_type = _classify_include(filename, previous_include, (previous_match.group(1) == '&lt;'))
</del><ins>+                    previous_header_type = include_state.header_types[previous_line_number]
</ins><span class="cx">                     if previous_header_type == _OTHER_HEADER and previous_line.strip() &gt; line.strip():
</span><span class="cx">                         error(filename, line_number, 'build/include_order', 4,
</span><span class="cx">                               'Alphabetical sorting problem.')
</span></span></pre></div>
<a id="trunkWebKitToolsScriptsmodulescpplint_unittestpy"></a>
<div class="modfile"><h4>Modified: trunk/WebKitTools/Scripts/modules/cpplint_unittest.py (46229 => 46230)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitTools/Scripts/modules/cpplint_unittest.py        2009-07-22 18:55:05 UTC (rev 46229)
+++ trunk/WebKitTools/Scripts/modules/cpplint_unittest.py        2009-07-22 19:24:13 UTC (rev 46230)
</span><span class="lines">@@ -2174,30 +2174,46 @@
</span><span class="cx"> 
</span><span class="cx">     def test_classify_include(self):
</span><span class="cx">         classify_include = cpplint._classify_include
</span><ins>+        include_state = cpplint._IncludeState()
</ins><span class="cx">         self.assertEqual(cpplint._CONFIG_HEADER,
</span><span class="cx">                          classify_include('foo/foo.cpp',
</span><span class="cx">                                           'config.h',
</span><del>-                                          False))
</del><ins>+                                          False, include_state))
</ins><span class="cx">         self.assertEqual(cpplint._PRIMARY_HEADER,
</span><span class="cx">                          classify_include('foo/internal/foo.cpp',
</span><span class="cx">                                           'foo/public/foo.h',
</span><del>-                                          False))
</del><ins>+                                          False, include_state))
</ins><span class="cx">         self.assertEqual(cpplint._PRIMARY_HEADER,
</span><span class="cx">                          classify_include('foo/internal/foo.cpp',
</span><span class="cx">                                           'foo/other/public/foo.h',
</span><del>-                                          False))
</del><ins>+                                          False, include_state))
</ins><span class="cx">         self.assertEqual(cpplint._OTHER_HEADER,
</span><span class="cx">                          classify_include('foo/internal/foo.cpp',
</span><span class="cx">                                           'foo/other/public/foop.h',
</span><del>-                                          False))
</del><ins>+                                          False, include_state))
</ins><span class="cx">         self.assertEqual(cpplint._OTHER_HEADER,
</span><span class="cx">                          classify_include('foo/foo.cpp',
</span><span class="cx">                                           'string',
</span><del>-                                          True))
</del><ins>+                                          True, include_state))
</ins><span class="cx">         self.assertEqual(cpplint._PRIMARY_HEADER,
</span><span class="cx">                          classify_include('fooCustom.cpp',
</span><span class="cx">                                           'foo.h',
</span><del>-                                          False))
</del><ins>+                                          False, include_state))
+        # Tricky example where both includes might be classified as primary.
+        self.assert_language_rules_check('ScrollbarThemeWince.cpp',
+                                         '#include &quot;config.h&quot;\n'
+                                         '#include &quot;ScrollbarThemeWince.h&quot;\n'
+                                         '\n'
+                                         '#include &quot;Scrollbar.h&quot;\n',
+                                         '')
+        self.assert_language_rules_check('ScrollbarThemeWince.cpp',
+                                         '#include &quot;config.h&quot;\n'
+                                         '#include &quot;Scrollbar.h&quot;\n'
+                                         '\n'
+                                         '#include &quot;ScrollbarThemeWince.h&quot;\n',
+                                         'Found header this file implements after a header this file implements.'
+                                         ' Should be: config.h, primary header, blank line, and then alphabetically sorted.'
+                                         '  [build/include_order] [4]')
</ins><span class="cx"> 
</span><span class="cx">     def test_try_drop_common_suffixes(self):
</span><span class="cx">         self.assertEqual('foo/foo', cpplint._drop_common_suffixes('foo/foo-inl.h'))
</span></span></pre>
</div>
</div>

</body>
</html>