| # Copyright 2012 The Chromium Authors |
| # 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 cc. |
| |
| See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts |
| for more details about the presubmit API built into depot_tools. |
| """ |
| |
| import re |
| |
| PRESUBMIT_VERSION='2.0.0' |
| |
| CC_SOURCE_FILES=(r'^cc[\\/].*\.(cc|h)$',) |
| |
| def_CheckChangeLintsClean(input_api, output_api): |
| allowlist= CC_SOURCE_FILES |
| denylist=None |
| source_filter=lambda x: input_api.FilterSourceFile(x, allowlist, denylist) |
| |
| return input_api.canned_checks.CheckChangeLintsClean( |
| input_api, output_api, source_filter, lint_filters=[], verbose_level=1) |
| |
| def_CheckAsserts(input_api, output_api, allowlist=CC_SOURCE_FILES, |
| denylist=None): |
| denylist= tuple(denylistor input_api.DEFAULT_FILES_TO_SKIP) |
| source_file_filter=lambda x: input_api.FilterSourceFile(x, allowlist, |
| denylist) |
| |
| assert_files=[] |
| |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| # WebKit ASSERT() is not allowed. |
| if re.search(r"\bASSERT\(", contents): |
| assert_files.append(f.LocalPath()) |
| |
| if assert_files: |
| return[output_api.PresubmitError( |
| 'These files use ASSERT instead of using DCHECK:', |
| items=assert_files)] |
| return[] |
| |
| def_CheckStdAbs(input_api, output_api, |
| allowlist=CC_SOURCE_FILES, denylist=None): |
| denylist= tuple(denylistor input_api.DEFAULT_FILES_TO_SKIP) |
| source_file_filter=lambda x: input_api.FilterSourceFile(x, |
| allowlist, |
| denylist) |
| |
| using_std_abs_files=[] |
| found_fabs_files=[] |
| missing_std_prefix_files=[] |
| |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| if re.search(r"using std::f?abs;", contents): |
| using_std_abs_files.append(f.LocalPath()) |
| if re.search(r"\bfabsf?\(", contents): |
| found_fabs_files.append(f.LocalPath()); |
| |
| no_std_prefix= r"(?<!std::)" |
| # Matches occurrences of abs/absf/fabs/fabsf without a "std::" prefix. |
| abs_without_prefix= r"%s(\babsf?\()"% no_std_prefix |
| fabs_without_prefix= r"%s(\bfabsf?\()"% no_std_prefix |
| # Skips matching any lines that have "// NOLINT". |
| no_nolint= r"(?![^\n]*//\s+NOLINT)" |
| |
| expression= re.compile("(%s|%s)%s"% |
| (abs_without_prefix, fabs_without_prefix, no_nolint)) |
| if expression.search(contents): |
| missing_std_prefix_files.append(f.LocalPath()) |
| |
| result=[] |
| if using_std_abs_files: |
| result.append(output_api.PresubmitError( |
| 'These files have "using std::abs" which is not permitted.', |
| items=using_std_abs_files)) |
| if found_fabs_files: |
| result.append(output_api.PresubmitError( |
| 'std::abs() should be used instead of std::fabs() for consistency.', |
| items=found_fabs_files)) |
| if missing_std_prefix_files: |
| result.append(output_api.PresubmitError( |
| 'These files use abs(), absf(), fabs(), or fabsf() without qualifying ' |
| 'the std namespace. Please use std::abs() in all places.', |
| items=missing_std_prefix_files)) |
| return result |
| |
| def_CheckPassByValue(input_api, |
| output_api, |
| allowlist=CC_SOURCE_FILES, |
| denylist=None): |
| denylist= tuple(denylistor input_api.DEFAULT_FILES_TO_SKIP) |
| source_file_filter=lambda x: input_api.FilterSourceFile(x, |
| allowlist, |
| denylist) |
| |
| local_errors=[] |
| |
| # Well-defined simple classes the same size as a primitive type. |
| pass_by_value_types=['base::Time', |
| 'base::TimeTicks', |
| ] |
| |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| sep='|' |
| match= re.search( |
| r'\bconst +'+'(?P<type>(%s))&'% sep.join(pass_by_value_types), |
| contents) |
| if match: |
| local_errors.append(output_api.PresubmitError( |
| '%s passes %s by const ref instead of by value.'% |
| (f.LocalPath(), match.group('type')))) |
| return local_errors |
| |
| def_CheckTodos(input_api, output_api): |
| errors=[] |
| |
| source_file_filter=lambda x: x |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| if('FIX'+'ME')in contents: |
| errors.append(f.LocalPath()) |
| |
| if errors: |
| return[output_api.PresubmitError( |
| 'All TODO comments should be of the form TODO(name/bug). '+ |
| 'Use TODO instead of FIX'+'ME', |
| items=errors)] |
| return[] |
| |
| def_CheckDoubleAngles(input_api, output_api, allowlist=CC_SOURCE_FILES, |
| denylist=None): |
| errors=[] |
| |
| source_file_filter=lambda x: input_api.FilterSourceFile(x, |
| allowlist, |
| denylist) |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| if('> >')in contents: |
| errors.append(f.LocalPath()) |
| |
| if errors: |
| return[output_api.PresubmitError('Use >> instead of > >:', items=errors)] |
| return[] |
| |
| def_FindUnquotedQuote(contents, pos): |
| match= re.search(r"(?<!\\)(?P<quote>\")", contents[pos:]) |
| return-1ifnot matchelse match.start("quote")+ pos |
| |
| def_FindUselessIfdefs(input_api, output_api): |
| errors=[] |
| source_file_filter=lambda x: x |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| if re.search(r'#if\s*0\s', contents): |
| errors.append(f.LocalPath()) |
| if errors: |
| return[output_api.PresubmitError( |
| 'Don\'t use #if '+'0; just delete the code.', |
| items=errors)] |
| return[] |
| |
| def_FindNamespaceInBlock(pos, namespace, contents, allowlist=[]): |
| open_brace=-1 |
| close_brace=-1 |
| quote=-1 |
| name=-1 |
| brace_count=1 |
| quote_count=0 |
| while pos< len(contents)and brace_count>0: |
| if open_brace< pos: open_brace= contents.find("{", pos) |
| if close_brace< pos: close_brace= contents.find("}", pos) |
| if quote< pos: quote=_FindUnquotedQuote(contents, pos) |
| if name< pos: name= contents.find(("%s::"% namespace), pos) |
| |
| if name<0: |
| returnFalse# The namespace is not used at all. |
| if open_brace<0: |
| open_brace= len(contents) |
| if close_brace<0: |
| close_brace= len(contents) |
| if quote<0: |
| quote= len(contents) |
| |
| next= min(open_brace, min(close_brace, min(quote, name))) |
| |
| if next== open_brace: |
| brace_count+=1 |
| elif next== close_brace: |
| brace_count-=1 |
| elif next== quote: |
| quote_count=0if quote_countelse1 |
| elif next== nameandnot quote_count: |
| in_allowlist=False |
| for win allowlist: |
| if re.match(w, contents[next:]): |
| in_allowlist=True |
| break |
| ifnot in_allowlist: |
| returnTrue |
| pos= next+1 |
| returnFalse |
| |
| # Checks for the use of cc:: within the cc namespace, which is usually |
| # redundant. |
| def_CheckNamespace(input_api, output_api): |
| errors=[] |
| |
| source_file_filter=lambda x: x |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| contents= input_api.ReadFile(f,'rb') |
| match= re.search(r'namespace\s*cc\s*{', contents) |
| if match: |
| allowlist=[] |
| if_FindNamespaceInBlock(match.end(), |
| 'cc', |
| contents, |
| allowlist=allowlist): |
| errors.append(f.LocalPath()) |
| |
| if errors: |
| return[output_api.PresubmitError( |
| 'Do not use cc:: inside of the cc namespace.', |
| items=errors)] |
| return[] |
| |
| def_CheckForUseOfWrongClock(input_api, |
| output_api, |
| allowlist=CC_SOURCE_FILES, |
| denylist=None): |
| """Make sure new lines of code don't use a clock susceptible to skew.""" |
| denylist= tuple(denylistor input_api.DEFAULT_FILES_TO_SKIP) |
| source_file_filter=lambda x: input_api.FilterSourceFile(x, |
| allowlist, |
| denylist) |
| # Regular expression that should detect any explicit references to the |
| # base::Time type (or base::Clock/DefaultClock), whether in using decls, |
| # typedefs, or to call static methods. |
| base_time_type_pattern= r'(^|\W)base::(Time|Clock|DefaultClock)(\W|$)' |
| |
| # Regular expression that should detect references to the base::Time class |
| # members, such as a call to base::Time::Now. |
| base_time_member_pattern= r'(^|\W)(Time|Clock|DefaultClock)::' |
| |
| # Regular expression to detect "using base::Time" declarations. We want to |
| # prevent these from triggerring a warning. For example, it's perfectly |
| # reasonable for code to be written like this: |
| # |
| # using base::Time; |
| # ... |
| # int64 foo_us = foo_s * Time::kMicrosecondsPerSecond; |
| using_base_time_decl_pattern= r'^\s*using\s+(::)?base::Time\s*;' |
| |
| # Regular expression to detect references to the kXXX constants in the |
| # base::Time class. We want to prevent these from triggerring a warning. |
| base_time_konstant_pattern= r'(^|\W)Time::k\w+' |
| |
| problem_re= input_api.re.compile( |
| r'('+ base_time_type_pattern+ r')|('+ base_time_member_pattern+ r')') |
| exception_re= input_api.re.compile( |
| r'('+ using_base_time_decl_pattern+ r')|('+ |
| base_time_konstant_pattern+ r')') |
| problems=[] |
| for fin input_api.AffectedSourceFiles(source_file_filter): |
| for line_number, linein f.ChangedContents(): |
| if problem_re.search(line): |
| ifnot exception_re.search(line): |
| problems.append( |
| ' %s:%d\n %s'%(f.LocalPath(), line_number, line.strip())) |
| |
| if problems: |
| return[output_api.PresubmitPromptOrNotify( |
| 'You added one or more references to the base::Time class and/or one\n' |
| 'of its member functions (or base::Clock/DefaultClock). In cc code,\n' |
| 'it is most certainly incorrect! Instead use base::TimeTicks.\n\n' |
| '\n'.join(problems))] |
| else: |
| return[] |
| |
| defCheckChangeOnUpload(input_api, output_api): |
| results=[] |
| results+=_CheckAsserts(input_api, output_api) |
| results+=_CheckStdAbs(input_api, output_api) |
| results+=_CheckPassByValue(input_api, output_api) |
| results+=_CheckChangeLintsClean(input_api, output_api) |
| results+=_CheckTodos(input_api, output_api) |
| results+=_CheckDoubleAngles(input_api, output_api) |
| results+=_CheckNamespace(input_api, output_api) |
| results+=_CheckForUseOfWrongClock(input_api, output_api) |
| results+=_FindUselessIfdefs(input_api, output_api) |
| return results |
