Ignore C++ comments while checking for Singleton<T> in headers.

depot_tools/presubmit_canned_checks.py

 # Copyright (c) 2010 The Chromium Authors. All rights reserved.

[M-A Ruel, 2011/08/26 13:12:45]

sorry but can you update it to 2011? Since the CQ is broken for depot_tools, it
won't be auto updated.

[Denis Lagno, 2011/08/26 13:31:33]

Done.

 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Generic presubmit checks that can be reused by other presubmit checks."""
 
 
 ### Description checks
 
 def CheckChangeHasTestField(input_api, output_api):
   """Requires that the changelist have a TEST= field."""
@@ skipping 809 matching lines @@
     else:
       res_type = output_api.PresubmitNotifyResult
     return [ res_type('|const NSClass*| is wrong, see ' +
                       'http://dev.chromium.org/developers/clang-mac',
                       files) ]
   return []
 
 
 def _CheckSingletonInHeaders(input_api, output_api, source_file_filter):
   """Checks to make sure no header files have |Singleton<|."""
-  pattern = input_api.re.compile(r'Singleton<')
+  pattern = input_api.re.compile(r'Singleton\s*<')
+
+  def strip_cpp_eol_comment(line):
+    pattern = input_api.re.compile(r'//.*$')
+    return pattern.sub('', line)

[M-A Ruel, 2011/08/26 13:12:45]

I'm not sure it's useful; using "input_api.re.sub(r'//.*$', '', line)" directly
at the call point, or on a separate named variable around like 843 since the
line would become longer, would be clearer IMHO.

wdyt?

[Denis Lagno, 2011/08/26 13:31:33]

Done.

+    
   files = []
   for f in input_api.AffectedSourceFiles(source_file_filter):
     if (f.LocalPath().endswith('.h') or f.LocalPath().endswith('.hxx') or
         f.LocalPath().endswith('.hpp') or f.LocalPath().endswith('.inl')):
       contents = input_api.ReadFile(f)
-      if pattern.search(contents):
-        files.append(f)
+      for line in contents.splitlines(False):
+        if pattern.search(strip_cpp_eol_comment(line)):
+          files.append(f)
+          break
 
   if files:
     return [ output_api.PresubmitError(
         'Found 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 []
 
 
@@ skipping 87 matching lines @@
     results.extend(input_api.canned_checks.CheckSvnForCommonMimeTypes(
         input_api, output_api))
     snapshot("checking license")
     results.extend(input_api.canned_checks.CheckLicense(
         input_api, output_api, license_header, source_file_filter=sources))
     snapshot("checking was uploaded")
     results.extend(input_api.canned_checks.CheckChangeWasUploaded(
         input_api, output_api))
   snapshot("done")
   return results