PRESUBMIT #include check: exclude known cases which need a non-standard order.

PRESUBMIT.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Top-level presubmit script for Chromium.
 
 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
 for more details about the presubmit API built into gcl.
 """
 
@@ skipping 539 matching lines @@
 
 
 def _CheckIncludeOrderInFile(input_api, f, changed_linenums):
   """Checks the #include order for the given file f."""
 
   system_include_pattern = input_api.re.compile(r'\s*#include \<.*')
   # Exclude #include <.../...> includes from the check; e.g., <sys/...> includes
   # often need to appear in a specific order.
   excluded_include_pattern = input_api.re.compile(r'\s*#include \<.*/.*')
   custom_include_pattern = input_api.re.compile(r'\s*#include "(?P<FILE>.*)"')
-  if_pattern = (
-      input_api.re.compile(r'\s*#\s*(if|elif|else|endif|define|undef).*'))
+  if_pattern = input_api.re.compile(
+      r'\s*#\s*(if|elif|else|endif|define|undef).*')
+  # Some files need specialized order of includes; exclude such files from this
+  # check.
+  uncheckable_includes_pattern = input_api.re.compile(
+      r'\s*#include '
+      '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
 
   contents = f.NewContents()
   warnings = []
   line_num = 0
 
   # Handle the special first include. If the first include file is
   # some/path/file.h, the corresponding including file can be some/path/file.cc,
   # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
   # etc. It's also possible that no special first include exists.
   for line in contents:
@@ skipping 12 matching lines @@
         # No special first include -> process the line again along with normal
         # includes.
         line_num -= 1
       break
 
   # Split into scopes: Each region between #if and #endif is its own scope.
   scopes = []
   current_scope = []
   for line in contents[line_num:]:
     line_num += 1
+    if uncheckable_includes_pattern.match(line):

[M-A Ruel, 2012/12/18 13:37:33]

Why not just skip the file instead of aborting?

[marja, 2012/12/18 14:57:40]

I assume you meant "line" instead of "file"; such a special include often
affects a couple of includes on the nearby lines, so, I'd need to skip them too
or suppress the errors -> it's easier to just skip the file in total.

Or if you meant "file", then, this code is in _ChekcIncludeOrderInFile, so, it
will only skip that file.

[M-A Ruel, 2012/12/18 20:02:07]

Yes I meant line and not file. I don't mind.

lgtm

+      return []
     if if_pattern.match(line):
       scopes.append(current_scope)
       current_scope = []
     elif ((system_include_pattern.match(line) or
            custom_include_pattern.match(line)) and
           not excluded_include_pattern.match(line)):
       current_scope.append((line_num, line))
   scopes.append(current_scope)
 
   for scope in scopes:
@@ skipping 268 matching lines @@
       'win_aura',
       'win_rel',
   ]
 
   # Match things like path/aura/file.cc and path/file_aura.cc.
   # Same for chromeos.
   if any(re.search('[/_](aura|chromeos)', f) for f in files):
     trybots += ['linux_chromeos_clang:compile', 'linux_chromeos_asan']
 
   return trybots