cpplint.py

#!/usr/bin/env python
#
# Copyright 2009 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Does google-lint on c++ files.

The goal of this script is to identify places in the code that *may*
be in non-compliance with google style. It does not attempt to fix
up these problems -- the point is to educate. It does also not
attempt to find all problems, or to ensure that everything it does
find is legitimately a problem.

In particular, we can get very confused by /* and // inside strings!
We do a small hack, which is to ignore //'s with "'s after them on the
same line, but it is far from perfect (in either direction).
"""

importcodecs
importcopy
importgetopt
importglob
importitertools
importmath# for log
importos
importre
importsre_compile
importstring
importsys
importsysconfig
importunicodedata
importxml.etree.ElementTree

# if empty, use defaults
_valid_extensions=set([])

__VERSION__='1.5.2'

try:
xrange# Python 2
exceptNameError:
# -- pylint: disable=redefined-builtin
xrange=range# Python 3


_USAGE="""
Syntax: cpplint.py [--verbose=#] [--output=emacs|eclipse|vs7|junit|sed|gsed]
 [--filter=-x,+y,...]
 [--counting=total|toplevel|detailed] [--root=subdir]
 [--repository=path]
 [--linelength=digits] [--headers=x,y,...]
 [--recursive]
 [--exclude=path]
 [--extensions=hpp,cpp,...]
 [--includeorder=default|standardcfirst]
 [--quiet]
 [--version]
 <file> [file] ...

 Style checker for C/C++ source files.
 This is a fork of the Google style checker with minor extensions.

 The style guidelines this tries to follow are those in
 https://google.github.io/styleguide/cppguide.html

 Every problem is given a confidence score from 1-5, with 5 meaning we are
 certain of the problem, and 1 meaning it could be a legitimate construct.
 This will miss some errors, and is not a substitute for a code review.

 To suppress false-positive errors of a certain category, add a
 'NOLINT(category)' comment to the line. NOLINT or NOLINT(*)
 suppresses errors of all categories on that line.

 The files passed in will be linted; at least one file must be provided.
 Default linted extensions are %s.
 Other file types will be ignored.
 Change the extensions with the --extensions flag.

 Flags:

 output=emacs|eclipse|vs7|junit|sed|gsed
 By default, the output is formatted to ease emacs parsing. Visual Studio
 compatible output (vs7) may also be used. Further support exists for
 eclipse (eclipse), and JUnit (junit). XML parsers such as those used
 in Jenkins and Bamboo may also be used.
 The sed format outputs sed commands that should fix some of the errors.
 Note that this requires gnu sed. If that is installed as gsed on your
 system (common e.g. on macOS with homebrew) you can use the gsed output
 format. Sed commands are written to stdout, not stderr, so you should be
 able to pipe output straight to a shell to run the fixes.

 verbose=#
 Specify a number 0-5 to restrict errors to certain verbosity levels.
 Errors with lower verbosity levels have lower confidence and are more
 likely to be false positives.

 quiet
 Don't print anything if no errors are found.

 filter=-x,+y,...
 Specify a comma-separated list of category-filters to apply: only
 error messages whose category names pass the filters will be printed.
 (Category names are printed with the message and look like
 "[whitespace/indent]".) Filters are evaluated left to right.
 "-FOO" and "FOO" means "do not print categories that start with FOO".
 "+FOO" means "do print categories that start with FOO".

 Examples: --filter=-whitespace,+whitespace/braces
 --filter=whitespace,runtime/printf,+runtime/printf_format
 --filter=-,+build/include_what_you_use

 To see a list of all the categories used in cpplint, pass no arg:
 --filter=

 counting=total|toplevel|detailed
 The total number of errors found is always printed. If
 'toplevel' is provided, then the count of errors in each of
 the top-level categories like 'build' and 'whitespace' will
 also be printed. If 'detailed' is provided, then a count
 is provided for each category like 'build/class'.

 repository=path
 The top level directory of the repository, used to derive the header
 guard CPP variable. By default, this is determined by searching for a
 path that contains .git, .hg, or .svn. When this flag is specified, the
 given path is used instead. This option allows the header guard CPP
 variable to remain consistent even if members of a team have different
 repository root directories (such as when checking out a subdirectory
 with SVN). In addition, users of non-mainstream version control systems
 can use this flag to ensure readable header guard CPP variables.

 Examples:
 Assuming that Alice checks out ProjectName and Bob checks out
 ProjectName/trunk and trunk contains src/chrome/ui/browser.h, then
 with no --repository flag, the header guard CPP variable will be:

 Alice => TRUNK_SRC_CHROME_BROWSER_UI_BROWSER_H_
 Bob => SRC_CHROME_BROWSER_UI_BROWSER_H_

 If Alice uses the --repository=trunk flag and Bob omits the flag or
 uses --repository=. then the header guard CPP variable will be:

 Alice => SRC_CHROME_BROWSER_UI_BROWSER_H_
 Bob => SRC_CHROME_BROWSER_UI_BROWSER_H_

 root=subdir
 The root directory used for deriving header guard CPP variable.
 This directory is relative to the top level directory of the repository
 which by default is determined by searching for a directory that contains
 .git, .hg, or .svn but can also be controlled with the --repository flag.
 If the specified directory does not exist, this flag is ignored.

 Examples:
 Assuming that src is the top level directory of the repository (and
 cwd=top/src), the header guard CPP variables for
 src/chrome/browser/ui/browser.h are:

 No flag => CHROME_BROWSER_UI_BROWSER_H_
 --root=chrome => BROWSER_UI_BROWSER_H_
 --root=chrome/browser => UI_BROWSER_H_
 --root=.. => SRC_CHROME_BROWSER_UI_BROWSER_H_

 linelength=digits
 This is the allowed line length for the project. The default value is
 80 characters.

 Examples:
 --linelength=120

 recursive
 Search for files to lint recursively. Each directory given in the list
 of files to be linted is replaced by all files that descend from that
 directory. Files with extensions not in the valid extensions list are
 excluded.

 exclude=path
 Exclude the given path from the list of files to be linted. Relative
 paths are evaluated relative to the current directory and shell globbing
 is performed. This flag can be provided multiple times to exclude
 multiple files.

 Examples:
 --exclude=one.cc
 --exclude=src/*.cc
 --exclude=src/*.cc --exclude=test/*.cc

 extensions=extension,extension,...
 The allowed file extensions that cpplint will check

 Examples:
 --extensions=%s

 includeorder=default|standardcfirst
 For the build/include_order rule, the default is to blindly assume angle
 bracket includes with file extension are c-system-headers (default),
 even knowing this will have false classifications.
 The default is established at google.
 standardcfirst means to instead use an allow-list of known c headers and
 treat all others as separate group of "other system headers". The C headers
 included are those of the C-standard lib and closely related ones.

 headers=x,y,...
 The header extensions that cpplint will treat as .h in checks. Values are
 automatically added to --extensions list.
 (by default, only files with extensions %s will be assumed to be headers)

 Examples:
 --headers=%s
 --headers=hpp,hxx
 --headers=hpp

 cpplint.py supports per-directory configurations specified in CPPLINT.cfg
 files. CPPLINT.cfg file can contain a number of key=value pairs.
 Currently the following options are supported:

 set noparent
 filter=+filter1,-filter2,...
 exclude_files=regex
 linelength=80
 root=subdir
 headers=x,y,...

 "set noparent" option prevents cpplint from traversing directory tree
 upwards looking for more .cfg files in parent directories. This option
 is usually placed in the top-level project directory.

 The "filter" option is similar in function to --filter flag. It specifies
 message filters in addition to the |_DEFAULT_FILTERS| and those specified
 through --filter command-line flag.

 "exclude_files" allows to specify a regular expression to be matched against
 a file name. If the expression matches, the file is skipped and not run
 through the linter.

 "linelength" allows to specify the allowed line length for the project.

 The "root" option is similar in function to the --root flag (see example
 above). Paths are relative to the directory of the CPPLINT.cfg.

 The "headers" option is similar in function to the --headers flag
 (see example above).

 CPPLINT.cfg has an effect on files in the same directory and all
 sub-directories, unless overridden by a nested configuration file.

 Example file:
 filter=-build/include_order,+build/include_alpha
 exclude_files=.*\\.cc

 The above example disables build/include_order warning and enables
 build/include_alpha as well as excludes all .cc from being
 processed by linter, in the current directory (where the .cfg
 file is located) and all sub-directories.
"""

# We categorize each error message we print. Here are the categories.
# We want an explicit list so we can list them all in cpplint --filter=.
# If you add a new error message with a new category, add it to the list
# here! cpplint_unittest.py should tell you if you forget to do this.
_ERROR_CATEGORIES= [
'build/class',
'build/c++11',
'build/c++14',
'build/c++tr1',
'build/deprecated',
'build/endif_comment',
'build/explicit_make_pair',
'build/forward_decl',
'build/header_guard',
'build/include',
'build/include_subdir',
'build/include_alpha',
'build/include_order',
'build/include_what_you_use',
'build/namespaces_headers',
'build/namespaces_literals',
'build/namespaces',
'build/printf_format',
'build/storage_class',
'legal/copyright',
'readability/alt_tokens',
'readability/braces',
'readability/casting',
'readability/check',
'readability/constructors',
'readability/fn_size',
'readability/inheritance',
'readability/multiline_comment',
'readability/multiline_string',
'readability/namespace',
'readability/nolint',
'readability/nul',
'readability/strings',
'readability/todo',
'readability/utf8',
'runtime/arrays',
'runtime/casting',
'runtime/explicit',
'runtime/int',
'runtime/init',
'runtime/invalid_increment',
'runtime/member_string_references',
'runtime/memset',
'runtime/indentation_namespace',
'runtime/operator',
'runtime/printf',
'runtime/printf_format',
'runtime/references',
'runtime/string',
'runtime/threadsafe_fn',
'runtime/vlog',
'whitespace/blank_line',
'whitespace/braces',
'whitespace/comma',
'whitespace/comments',
'whitespace/empty_conditional_body',
'whitespace/empty_if_body',
'whitespace/empty_loop_body',
'whitespace/end_of_line',
'whitespace/ending_newline',
'whitespace/forcolon',
'whitespace/indent',
'whitespace/line_length',
'whitespace/newline',
'whitespace/operators',
'whitespace/parens',
'whitespace/semicolon',
'whitespace/tab',
'whitespace/todo',
 ]

# keywords to use with --outputs which generate stdout for machine processing
_MACHINE_OUTPUTS= [
'junit',
'sed',
'gsed'
]

# These error categories are no longer enforced by cpplint, but for backwards-
# compatibility they may still appear in NOLINT comments.
_LEGACY_ERROR_CATEGORIES= [
'readability/streams',
'readability/function',
 ]

# The default state of the category filter. This is overridden by the --filter=
# flag. By default all errors are on, so only add here categories that should be
# off by default (i.e., categories that must be enabled by the --filter= flags).
# All entries here should start with a '-' or '+', as in the --filter= flag.
_DEFAULT_FILTERS= ['-build/include_alpha']

# The default list of categories suppressed for C (not C++) files.
_DEFAULT_C_SUPPRESSED_CATEGORIES= [
'readability/casting',
 ]

# The default list of categories suppressed for Linux Kernel files.
_DEFAULT_KERNEL_SUPPRESSED_CATEGORIES= [
'whitespace/tab',
 ]

# We used to check for high-bit characters, but after much discussion we
# decided those were OK, as long as they were in UTF-8 and didn't represent
# hard-coded international strings, which belong in a separate i18n file.

# C++ headers
_CPP_HEADERS=frozenset([
# Legacy
'algobase.h',
'algo.h',
'alloc.h',
'builtinbuf.h',
'bvector.h',
'complex.h',
'defalloc.h',
'deque.h',
'editbuf.h',
'fstream.h',
'function.h',
'hash_map',
'hash_map.h',
'hash_set',
'hash_set.h',
'hashtable.h',
'heap.h',
'indstream.h',
'iomanip.h',
'iostream.h',
'istream.h',
'iterator.h',
'list.h',
'map.h',
'multimap.h',
'multiset.h',
'ostream.h',
'pair.h',
'parsestream.h',
'pfstream.h',
'procbuf.h',
'pthread_alloc',
'pthread_alloc.h',
'rope',
'rope.h',
'ropeimpl.h',
'set.h',
'slist',
'slist.h',
'stack.h',
'stdiostream.h',
'stl_alloc.h',
'stl_relops.h',
'streambuf.h',
'stream.h',
'strfile.h',
'strstream.h',
'tempbuf.h',
'tree.h',
'type_traits.h',
'vector.h',
# 17.6.1.2 C++ library headers
'algorithm',
'array',
'atomic',
'bitset',
'chrono',
'codecvt',
'complex',
'condition_variable',
'deque',
'exception',
'forward_list',
'fstream',
'functional',
'future',
'initializer_list',
'iomanip',
'ios',
'iosfwd',
'iostream',
'istream',
'iterator',
'limits',
'list',
'locale',
'map',
'memory',
'mutex',
'new',
'numeric',
'ostream',
'queue',
'random',
'ratio',
'regex',
'scoped_allocator',
'set',
'sstream',
'stack',
'stdexcept',
'streambuf',
'string',
'strstream',
'system_error',
'thread',
'tuple',
'typeindex',
'typeinfo',
'type_traits',
'unordered_map',
'unordered_set',
'utility',
'valarray',
'vector',
# 17.6.1.2 C++14 headers
'shared_mutex',
# 17.6.1.2 C++17 headers
'any',
'charconv',
'codecvt',
'execution',
'filesystem',
'memory_resource',
'optional',
'string_view',
'variant',
# 17.6.1.2 C++ headers for C library facilities
'cassert',
'ccomplex',
'cctype',
'cerrno',
'cfenv',
'cfloat',
'cinttypes',
'ciso646',
'climits',
'clocale',
'cmath',
'csetjmp',
'csignal',
'cstdalign',
'cstdarg',
'cstdbool',
'cstddef',
'cstdint',
'cstdio',
'cstdlib',
'cstring',
'ctgmath',
'ctime',
'cuchar',
'cwchar',
'cwctype',
 ])

# C headers
_C_HEADERS=frozenset([
# System C headers
'assert.h',
'complex.h',
'ctype.h',
'errno.h',
'fenv.h',
'float.h',
'inttypes.h',
'iso646.h',
'limits.h',
'locale.h',
'math.h',
'setjmp.h',
'signal.h',
'stdalign.h',
'stdarg.h',
'stdatomic.h',
'stdbool.h',
'stddef.h',
'stdint.h',
'stdio.h',
'stdlib.h',
'stdnoreturn.h',
'string.h',
'tgmath.h',
'threads.h',
'time.h',
'uchar.h',
'wchar.h',
'wctype.h',
# additional POSIX C headers
'aio.h',
'arpa/inet.h',
'cpio.h',
'dirent.h',
'dlfcn.h',
'fcntl.h',
'fmtmsg.h',
'fnmatch.h',
'ftw.h',
'glob.h',
'grp.h',
'iconv.h',
'langinfo.h',
'libgen.h',
'monetary.h',
'mqueue.h',
'ndbm.h',
'net/if.h',
'netdb.h',
'netinet/in.h',
'netinet/tcp.h',
'nl_types.h',
'poll.h',
'pthread.h',
'pwd.h',
'regex.h',
'sched.h',
'search.h',
'semaphore.h',
'setjmp.h',
'signal.h',
'spawn.h',
'strings.h',
'stropts.h',
'syslog.h',
'tar.h',
'termios.h',
'trace.h',
'ulimit.h',
'unistd.h',
'utime.h',
'utmpx.h',
'wordexp.h',
# additional GNUlib headers
'a.out.h',
'aliases.h',
'alloca.h',
'ar.h',
'argp.h',
'argz.h',
'byteswap.h',
'crypt.h',
'endian.h',
'envz.h',
'err.h',
'error.h',
'execinfo.h',
'fpu_control.h',
'fstab.h',
'fts.h',
'getopt.h',
'gshadow.h',
'ieee754.h',
'ifaddrs.h',
'libintl.h',
'mcheck.h',
'mntent.h',
'obstack.h',
'paths.h',
'printf.h',
'pty.h',
'resolv.h',
'shadow.h',
'sysexits.h',
'ttyent.h',
# Additional linux glibc headers
'dlfcn.h',
'elf.h',
'features.h',
'gconv.h',
'gnu-versions.h',
'lastlog.h',
'libio.h',
'link.h',
'malloc.h',
'memory.h',
'netash/ash.h',
'netatalk/at.h',
'netax25/ax25.h',
'neteconet/ec.h',
'netipx/ipx.h',
'netiucv/iucv.h',
'netpacket/packet.h',
'netrom/netrom.h',
'netrose/rose.h',
'nfs/nfs.h',
'nl_types.h',
'nss.h',
're_comp.h',
'regexp.h',
'sched.h',
'sgtty.h',
'stab.h',
'stdc-predef.h',
'stdio_ext.h',
'syscall.h',
'termio.h',
'thread_db.h',
'ucontext.h',
'ustat.h',
'utmp.h',
'values.h',
'wait.h',
'xlocale.h',
# Hardware specific headers
'arm_neon.h',
'emmintrin.h',
'xmmintin.h',
 ])

# Folders of C libraries so commonly used in C++,
# that they have parity with standard C libraries.
C_STANDARD_HEADER_FOLDERS=frozenset([
# standard C library
"sys",
# glibc for linux
"arpa",
"asm-generic",
"bits",
"gnu",
"net",
"netinet",
"protocols",
"rpc",
"rpcsvc",
"scsi",
# linux kernel header
"drm",
"linux",
"misc",
"mtd",
"rdma",
"sound",
"video",
"xen",
 ])

_C_SYSTEM_DIRECTORIES=frozenset([
'SystemConfiguration',
'dispatch',
'libkern',
'mach',
'netinet',
'objc',
'sys',
])

# Type names
_TYPES=re.compile(
r'^(?:'
# [dcl.type.simple]
r'(char(16_t|32_t)?)|wchar_t|'
r'bool|short|int|long|signed|unsigned|float|double|'
# [support.types]
r'(ptrdiff_t|size_t|max_align_t|nullptr_t)|'
# [cstdint.syn]
r'(u?int(_fast|_least)?(8|16|32|64)_t)|'
r'(u?int(max|ptr)_t)|'
r')$')


# These headers are excluded from [build/include] and [build/include_order]
# checks:
# - Anything not following google file name conventions (containing an
# uppercase character, such as Python.h or nsStringAPI.h, for example).
# - Lua headers.
_THIRD_PARTY_HEADERS_PATTERN=re.compile(
r'^(?:[^/]*[A-Z][^/]*\.h|lua\.h|lauxlib\.h|lualib\.h)$')

# Pattern for matching FileInfo.BaseName() against test file name
_test_suffixes= ['_test', '_regtest', '_unittest']
_TEST_FILE_SUFFIX='('+'|'.join(_test_suffixes) +r')$'

# Pattern that matches only complete whitespace, possibly across multiple lines.
_EMPTY_CONDITIONAL_BODY_PATTERN=re.compile(r'^\s*$', re.DOTALL)

# Assertion macros. These are defined in base/logging.h and
# testing/base/public/gunit.h.
_CHECK_MACROS= [
'DCHECK', 'CHECK',
'EXPECT_TRUE', 'ASSERT_TRUE',
'EXPECT_FALSE', 'ASSERT_FALSE',
 ]

# Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE
_CHECK_REPLACEMENT=dict([(macro_var, {}) formacro_varin_CHECK_MACROS])

forop, replacementin [('==', 'EQ'), ('!=', 'NE'),
 ('>=', 'GE'), ('>', 'GT'),
 ('<=', 'LE'), ('<', 'LT')]:
_CHECK_REPLACEMENT['DCHECK'][op] ='DCHECK_%s'%replacement
_CHECK_REPLACEMENT['CHECK'][op] ='CHECK_%s'%replacement
_CHECK_REPLACEMENT['EXPECT_TRUE'][op] ='EXPECT_%s'%replacement
_CHECK_REPLACEMENT['ASSERT_TRUE'][op] ='ASSERT_%s'%replacement

forop, inv_replacementin [('==', 'NE'), ('!=', 'EQ'),
 ('>=', 'LT'), ('>', 'LE'),
 ('<=', 'GT'), ('<', 'GE')]:
_CHECK_REPLACEMENT['EXPECT_FALSE'][op] ='EXPECT_%s'%inv_replacement
_CHECK_REPLACEMENT['ASSERT_FALSE'][op] ='ASSERT_%s'%inv_replacement

# Alternative tokens and their replacements. For full list, see section 2.5
# Alternative tokens [lex.digraph] in the C++ standard.
#
# Digraphs (such as '%:') are not included here since it's a mess to
# match those on a word boundary.
_ALT_TOKEN_REPLACEMENT= {
'and': '&&',
'bitor': '|',
'or': '||',
'xor': '^',
'compl': '~',
'bitand': '&',
'and_eq': '&=',
'or_eq': '|=',
'xor_eq': '^=',
'not': '!',
'not_eq': '!='
 }

# Compile regular expression that matches all the above keywords. The "[ =()]"
# bit is meant to avoid matching these keywords outside of boolean expressions.
#
# False positives include C-style multi-line comments and multi-line strings
# but those have always been troublesome for cpplint.
_ALT_TOKEN_REPLACEMENT_PATTERN=re.compile(
r'[ =()]('+ ('|'.join(_ALT_TOKEN_REPLACEMENT.keys())) +r')(?=[ (]|$)')


# These constants define types of headers for use with
# _IncludeState.CheckNextIncludeOrder().
_C_SYS_HEADER=1
_CPP_SYS_HEADER=2
_OTHER_SYS_HEADER=3
_LIKELY_MY_HEADER=4
_POSSIBLE_MY_HEADER=5
_OTHER_HEADER=6

# These constants define the current inline assembly state
_NO_ASM=0# Outside of inline assembly block
_INSIDE_ASM=1# Inside inline assembly block
_END_ASM=2# Last line of inline assembly block
_BLOCK_ASM=3# The whole block is an inline assembly block

# Match start of assembly blocks
_MATCH_ASM=re.compile(r'^\s*(?:asm|_asm|__asm|__asm__)'
r'(?:\s+(volatile|__volatile__))?'
r'\s*[{(]')

# Match strings that indicate we're working on a C (not C++) file.
_SEARCH_C_FILE=re.compile(r'\b(?:LINT_C_FILE|'
r'vim?:\s*.*(\s*|:)filetype=c(\s*|:|$))')

# Match string that indicates we're working on a Linux Kernel file.
_SEARCH_KERNEL_FILE=re.compile(r'\b(?:LINT_KERNEL_FILE)')

# Commands for sed to fix the problem
_SED_FIXUPS= {
'Remove spaces around =': r's/ = /=/',
'Remove spaces around !=': r's/ != /!=/',
'Remove space before ( in if (': r's/if (/if(/',
'Remove space before ( in for (': r's/for (/for(/',
'Remove space before ( in while (': r's/while (/while(/',
'Remove space before ( in switch (': r's/switch (/switch(/',
'Should have a space between // and comment': r's/\/\//\/\/ /',
'Missing space before {': r's/\([^ ]\){/\1 {/',
'Tab found, replace by spaces': r's/\t/ /g',
'Line ends in whitespace. Consider deleting these extra spaces.': r's/\s*$//',
'You don\'t need a ; after a }': r's/};/}/',
'Missing space after ,': r's/,\([^ ]\)/, \1/g',
}

_regexp_compile_cache= {}

# {str, set(int)}: a map from error categories to sets of linenumbers
# on which those errors are expected and should be suppressed.
_error_suppressions= {}

# The root directory used for deriving header guard CPP variable.
# This is set by --root flag.
_root=None
_root_debug=False

# The top level repository directory. If set, _root is calculated relative to
# this directory instead of the directory containing version control artifacts.
# This is set by the --repository flag.
_repository=None

# Files to exclude from linting. This is set by the --exclude flag.
_excludes=None

# Whether to supress all PrintInfo messages, UNRELATED to --quiet flag
_quiet=False

# The allowed line length of files.
# This is set by --linelength flag.
_line_length=80

# This allows to use different include order rule than default
_include_order="default"

try:
unicode
exceptNameError:
# -- pylint: disable=redefined-builtin
basestring=unicode=str

try:
long
exceptNameError:
# -- pylint: disable=redefined-builtin
long=int

ifsys.version_info< (3,):
# -- pylint: disable=no-member
# BINARY_TYPE = str
itervalues=dict.itervalues
iteritems=dict.iteritems
else:
# BINARY_TYPE = bytes
itervalues=dict.values
iteritems=dict.items

defunicode_escape_decode(x):
ifsys.version_info< (3,):
returncodecs.unicode_escape_decode(x)[0]
else:
returnx

# Treat all headers starting with 'h' equally: .h, .hpp, .hxx etc.
# This is set by --headers flag.
_hpp_headers=set([])

# {str, bool}: a map from error categories to booleans which indicate if the
# category should be suppressed for every line.
_global_error_suppressions= {}

defProcessHppHeadersOption(val):
global_hpp_headers
try:
_hpp_headers= {ext.strip() forextinval.split(',')}
exceptValueError:
PrintUsage('Header extensions must be comma separated list.')

defProcessIncludeOrderOption(val):
ifvalisNoneorval=="default":
pass
elifval=="standardcfirst":
global_include_order
_include_order=val
else:
PrintUsage('Invalid includeorder value %s. Expected default|standardcfirst')

defIsHeaderExtension(file_extension):
returnfile_extensioninGetHeaderExtensions()

defGetHeaderExtensions():
if_hpp_headers:
return_hpp_headers
if_valid_extensions:
return {hforhin_valid_extensionsif'h'inh}
returnset(['h', 'hh', 'hpp', 'hxx', 'h++', 'cuh'])

# The allowed extensions for file names
# This is set by --extensions flag
defGetAllExtensions():
returnGetHeaderExtensions().union(_valid_extensionsorset(
 ['c', 'cc', 'cpp', 'cxx', 'c++', 'cu', 'm', 'mm']))

defProcessExtensionsOption(val):
global_valid_extensions
try:
extensions= [ext.strip() forextinval.split(',')]
_valid_extensions=set(extensions)
exceptValueError:
PrintUsage('Extensions should be a comma-separated list of values;'
'for example: extensions=hpp,cpp\n'
'This could not be parsed: "%s"'% (val,))

defGetNonHeaderExtensions():
returnGetAllExtensions().difference(GetHeaderExtensions())

defParseNolintSuppressions(filename, raw_line, linenum, error):
"""Updates the global list of line error-suppressions.

 Parses any NOLINT comments on the current line, updating the global
 error_suppressions store. Reports an error if the NOLINT comment
 was malformed.

 Args:
 filename: str, the name of the input file.
 raw_line: str, the line of input text, with comments.
 linenum: int, the number of the current line.
 error: function, an error handler.
 """
matched=Search(r'\bNOLINT(NEXTLINE)?\b(\([^)]+\))?', raw_line)
ifmatched:
ifmatched.group(1):
suppressed_line=linenum+1
else:
suppressed_line=linenum
category=matched.group(2)
ifcategoryin (None, '(*)'): # => "suppress all"
_error_suppressions.setdefault(None, set()).add(suppressed_line)
else:
ifcategory.startswith('(') andcategory.endswith(')'):
category=category[1:-1]
ifcategoryin_ERROR_CATEGORIES:
_error_suppressions.setdefault(category, set()).add(suppressed_line)
elifcategorynotin_LEGACY_ERROR_CATEGORIES:
error(filename, linenum, 'readability/nolint', 5,
'Unknown NOLINT error category: %s'%category)


defProcessGlobalSuppresions(lines):
"""Updates the list of global error suppressions.

 Parses any lint directives in the file that have global effect.

 Args:
 lines: An array of strings, each representing a line of the file, with the
 last element being empty if the file is terminated with a newline.
 """
forlineinlines:
if_SEARCH_C_FILE.search(line):
forcategoryin_DEFAULT_C_SUPPRESSED_CATEGORIES:
_global_error_suppressions[category] =True
if_SEARCH_KERNEL_FILE.search(line):
forcategoryin_DEFAULT_KERNEL_SUPPRESSED_CATEGORIES:
_global_error_suppressions[category] =True