PRESUBMIT: Bark about DISALLOW_* macros without #include "base/macros.h"

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 depot_tools.
 """
 
@@ skipping 1499 matching lines @@
 
   if files:
     return [ output_api.PresubmitError(
         'Found base::Singleton<T> in the following header files.\n' +
         'Please move them to an appropriate source file so that the ' +
         'template gets instantiated in a single compilation unit.',
         files) ]
   return []
 
 
+def _CheckBaseMacrosInHeaders(input_api, output_api):
+  """Check for base/macros.h if DISALLOW_* macro is used."""
+
+  disallows = ['DISALLOW_%s' % s for s in ('ASSIGN', 'COPY', 'EVIL')]

[M-A Ruel, 2015/10/16 21:09:25]

I'd call this an early generalisation;

disallows = ('DISALLOW_ASSIGN', 'DISALLOW_COPY', 'DISALLOW_EVIL')
disallows = ['DISALLOW_%s' % s for s in ('ASSIGN', 'COPY', 'EVIL')]

[Dan Beam, 2015/10/16 21:24:15]

Done. (those 2 characters thank you!)

+  macros = '#include "base/macros.h"'
+  basictypes = '#include "base/basictypes.h"'
+
+  files = []
+  for f in input_api.AffectedSourceFiles(None):
+    if not f.LocalPath().endswith('.h'):
+      continue
+    for line_num, line in f.ChangedContents():
+      if any(d in line for d in disallows):
+        contents = input_api.ReadFile(f)
+        if not (macros in contents or basictypes in contents):
+          files.append(f)
+          break
+
+  msg = ('The following files appear to be using DISALLOW_* macros.\n'
+         'Please #include "base/macros.h" in them.')
+  return [output_api.PresubmitError(msg, files)] if files else []
+
+
 _DEPRECATED_CSS = [
   # Values
   ( "-webkit-box", "flex" ),
   ( "-webkit-inline-box", "inline-flex" ),
   ( "-webkit-flex", "flex" ),
   ( "-webkit-inline-flex", "inline-flex" ),
   ( "-webkit-min-content", "min-content" ),
   ( "-webkit-max-content", "max-content" ),
 
   # Properties
@@ skipping 109 matching lines @@
   results.extend(_CheckForAnonymousVariables(input_api, output_api))
   results.extend(_CheckCygwinShell(input_api, output_api))
   results.extend(_CheckUserActionUpdate(input_api, output_api))
   results.extend(_CheckNoDeprecatedCSS(input_api, output_api))
   results.extend(_CheckNoDeprecatedJS(input_api, output_api))
   results.extend(_CheckParseErrors(input_api, output_api))
   results.extend(_CheckForIPCRules(input_api, output_api))
   results.extend(_CheckForCopyrightedCode(input_api, output_api))
   results.extend(_CheckForWindowsLineEndings(input_api, output_api))
   results.extend(_CheckSingletonInHeaders(input_api, output_api))
+  results.extend(_CheckBaseMacrosInHeaders(input_api, output_api))
 
   if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
     results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
         input_api, output_api,
         input_api.PresubmitLocalPath(),
         whitelist=[r'^PRESUBMIT_test\.py$']))
   return results
 
 
 def _CheckAuthorizedAuthor(input_api, output_api):
@@ skipping 291 matching lines @@
   for master in masters:
     try_config.setdefault(master, {})
     for builder in masters[master]:
       # Do not trigger presubmit builders, since they're likely to fail
       # (e.g. OWNERS checks before finished code review), and we're
       # running local presubmit anyway.
       if 'presubmit' not in builder:
         try_config[master][builder] = ['defaulttests']
 
   return try_config