PRESUBMIT #include check enhancements.

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 524 matching lines @@
     previous_line = line
     previous_line_num = line_num
 
   warnings = []
   for (line_num, previous_line_num) in problem_linenums:
     if line_num in changed_linenums or previous_line_num in changed_linenums:
       warnings.append('    %s:%d' % (file_path, line_num))
   return warnings
 
 
-def _CheckIncludeOrderInFile(input_api, f, is_source, changed_linenums):
+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).*')
+  if_pattern = (
+      input_api.re.compile(r'\s*#\s*(if|elif|else|endif|define|undef).*'))
 
   contents = f.NewContents()
   warnings = []
   line_num = 0
 
-  # Handle the special first include for source files. If the header file is
-  # some/path/file.h, the corresponding source file can be some/path/file.cc,
-  # some/other/path/file.cc, some/path/file_platform.cc etc. It's also possible
-  # that no special first include exists.
-  if is_source:
-    for line in contents:
-      line_num += 1
-      if system_include_pattern.match(line):
+  # 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:
+    line_num += 1
+    if system_include_pattern.match(line):
+      # No special first include -> process the line again along with normal
+      # includes.
+      line_num -= 1
+      break
+    match = custom_include_pattern.match(line)
+    if match:
+      match_dict = match.groupdict()
+      header_basename = input_api.os_path.basename(
+          match_dict['FILE']).replace('.h', '')
+      if header_basename not in input_api.os_path.basename(f.LocalPath()):
         # No special first include -> process the line again along with normal
         # includes.
         line_num -= 1
-        break
-      match = custom_include_pattern.match(line)
-      if match:
-        match_dict = match.groupdict()
-        header_basename = input_api.os_path.basename(
-            match_dict['FILE']).replace('.h', '')
-        if header_basename not in input_api.os_path.basename(f.LocalPath()):
-          # No special first include -> process the line again along with normal
-          # includes.
-          line_num -= 1
-        break
+      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 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:
     warnings.extend(_CheckIncludeOrderForScope(scope, input_api, f.LocalPath(),
                                                changed_linenums))
   return warnings
 
 
 def _CheckIncludeOrder(input_api, output_api):
   """Checks that the #include order is correct.
 
   1. The corresponding header for source files.
   2. C system files in alphabetical order
   3. C++ system files in alphabetical order
   4. Project's .h files in alphabetical order
 
-  Each region between #if and #endif follows these rules separately.
+  Each region separated by #if, #elif, #else, #endif, #define and #undef follows
+  these rules separately.
   """
 
   warnings = []
   for f in input_api.AffectedFiles():
     changed_linenums = set([line_num for line_num, _ in f.ChangedContents()])
-    if f.LocalPath().endswith('.cc'):
-      warnings.extend(_CheckIncludeOrderInFile(input_api, f, True,
-                                               changed_linenums))
-    elif f.LocalPath().endswith('.h'):
-      warnings.extend(_CheckIncludeOrderInFile(input_api, f, False,
-                                               changed_linenums))
+    warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))

[M-A Ruel, 2012/12/06 15:16:32]

Do you really want to run it over .java and .py files?

[marja, 2012/12/06 15:23:08]

-> fixed

 
   results = []
   if warnings:
     results.append(output_api.PresubmitPromptWarning(_INCLUDE_ORDER_WARNING,
                                                      warnings))
   return results
 
 
 def _CheckForVersionControlConflictsInFile(input_api, f):
   pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
@@ skipping 182 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