| blob | 52cb7d0cabed3c3122c320d879d2d9d01fab986b |
1 #!/usr/bin/env python
2 #
3 # Copyright (c) 2009 Google Inc. All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
7 # met:
8 #
9 # * Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # * Redistributions in binary form must reproduce the above
12 # copyright notice, this list of conditions and the following disclaimer
13 # in the documentation and/or other materials provided with the
14 # distribution.
15 # * Neither the name of Google Inc. nor the names of its
16 # contributors may be used to endorse or promote products derived from
17 # this software without specific prior written permission.
18 #
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 """Does google-lint on c++ files.
33 The goal of this script is to identify places in the code that *may*
34 be in non-compliance with google style. It does not attempt to fix
35 up these problems -- the point is to educate. It does also not
36 attempt to find all problems, or to ensure that everything it does
37 find is legitimately a problem.
39 In particular, we can get very confused by /* and // inside strings!
40 We do a small hack, which is to ignore //'s with "'s after them on the
41 same line, but it is far from perfect (in either direction).
42 """
44 import codecs
45 import copy
46 import getopt
48 import os
49 import re
50 import sre_compile
51 import string
52 import sys
53 import unicodedata
57 Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]
58 [--counting=total|toplevel|detailed] [--root=subdir]
59 [--linelength=digits] [--headers=x,y,...]
60 <file> [file] ...
62 The style guidelines this tries to follow are those in
63 https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
65 Every problem is given a confidence score from 1-5, with 5 meaning we are
66 certain of the problem, and 1 meaning it could be a legitimate construct.
67 This will miss some errors, and is not a substitute for a code review.
69 To suppress false-positive errors of a certain category, add a
70 'NOLINT(category)' comment to the line. NOLINT or NOLINT(*)
71 suppresses errors of all categories on that line.
73 The files passed in will be linted; at least one file must be provided.
74 Default linted extensions are .cc, .cpp, .cu, .cuh and .h. Change the
75 extensions with the --extensions flag.
77 Flags:
79 output=vs7
80 By default, the output is formatted to ease emacs parsing. Visual Studio
81 compatible output (vs7) may also be used. Other formats are unsupported.
83 verbose=#
84 Specify a number 0-5 to restrict errors to certain verbosity levels.
86 filter=-x,+y,...
87 Specify a comma-separated list of category-filters to apply: only
88 error messages whose category names pass the filters will be printed.
89 (Category names are printed with the message and look like
90 "[whitespace/indent]".) Filters are evaluated left to right.
91 "-FOO" and "FOO" means "do not print categories that start with FOO".
92 "+FOO" means "do print categories that start with FOO".
94 Examples: --filter=-whitespace,+whitespace/braces
95 --filter=whitespace,runtime/printf,+runtime/printf_format
96 --filter=-,+build/include_what_you_use
98 To see a list of all the categories used in cpplint, pass no arg:
99 --filter=
101 counting=total|toplevel|detailed
102 The total number of errors found is always printed. If
103 'toplevel' is provided, then the count of errors in each of
104 the top-level categories like 'build' and 'whitespace' will
105 also be printed. If 'detailed' is provided, then a count
106 is provided for each category like 'build/class'.
108 root=subdir
109 The root directory used for deriving header guard CPP variable.
110 By default, the header guard CPP variable is calculated as the relative
111 path to the directory that contains .git, .hg, or .svn. When this flag
112 is specified, the relative path is calculated from the specified
113 directory. If the specified directory does not exist, this flag is
114 ignored.
116 Examples:
117 Assuming that src/.git exists, the header guard CPP variables for
118 src/chrome/browser/ui/browser.h are:
120 No flag => CHROME_BROWSER_UI_BROWSER_H_
121 --root=chrome => BROWSER_UI_BROWSER_H_
122 --root=chrome/browser => UI_BROWSER_H_
124 linelength=digits
125 This is the allowed line length for the project. The default value is
126 80 characters.
128 Examples:
129 --linelength=120
131 extensions=extension,extension,...
132 The allowed file extensions that cpplint will check
134 Examples:
135 --extensions=hpp,cpp
137 headers=x,y,...
138 The header extensions that cpplint will treat as .h in checks. Values are
139 automatically added to --extensions list.
141 Examples:
142 --headers=hpp,hxx
143 --headers=hpp
145 cpplint.py supports per-directory configurations specified in CPPLINT.cfg
146 files. CPPLINT.cfg file can contain a number of key=value pairs.
147 Currently the following options are supported:
149 set noparent
150 filter=+filter1,-filter2,...
151 exclude_files=regex
152 linelength=80
153 root=subdir
154 headers=x,y,...
156 "set noparent" option prevents cpplint from traversing directory tree
157 upwards looking for more .cfg files in parent directories. This option
158 is usually placed in the top-level project directory.
160 The "filter" option is similar in function to --filter flag. It specifies
161 message filters in addition to the |_DEFAULT_FILTERS| and those specified
162 through --filter command-line flag.
164 "exclude_files" allows to specify a regular expression to be matched against
165 a file name. If the expression matches, the file is skipped and not run
166 through liner.
168 "linelength" allows to specify the allowed line length for the project.
170 The "root" option is similar in function to the --root flag (see example
171 above).
173 The "headers" option is similar in function to the --headers flag
174 (see example above).
176 CPPLINT.cfg has an effect on files in the same directory and all
177 sub-directories, unless overridden by a nested configuration file.
179 Example file:
180 filter=-build/include_order,+build/include_alpha
181 exclude_files=.*\.cc
183 The above example disables build/include_order warning and enables
184 build/include_alpha as well as excludes all .cc from being
185 processed by linter, in the current directory (where the .cfg
186 file is located) and all sub-directories.
187 """
189 # We categorize each error message we print. Here are the categories.
190 # We want an explicit list so we can list them all in cpplint --filter=.
191 # If you add a new error message with a new category, add it to the list
192 # here! cpplint_unittest.py should tell you if you forget to do this.
193 _ERROR_CATEGORIES = [
260 ]
262 # These error categories are no longer enforced by cpplint, but for backwards-
263 # compatibility they may still appear in NOLINT comments.
264 _LEGACY_ERROR_CATEGORIES = [
267 ]
269 # The default state of the category filter. This is overridden by the --filter=
270 # flag. By default all errors are on, so only add here categories that should be
271 # off by default (i.e., categories that must be enabled by the --filter= flags).
272 # All entries here should start with a '-' or '+', as in the --filter= flag.
275 # The default list of categories suppressed for C (not C++) files.
276 _DEFAULT_C_SUPPRESSED_CATEGORIES = [
278 ]
280 # The default list of categories suppressed for Linux Kernel files.
281 _DEFAULT_KERNEL_SUPPRESSED_CATEGORIES = [
283 ]
285 # We used to check for high-bit characters, but after much discussion we
286 # decided those were OK, as long as they were in UTF-8 and didn't represent
287 # hard-coded international strings, which belong in a separate i18n file.
289 # C++ headers
291 # Legacy
343 # 17.6.1.2 C++ library headers
397 # 17.6.1.2 C++ headers for C library facilities
424 ])
426 # Type names
428 r'^(?:'
429 # [dcl.type.simple]
430 r'(char(16_t|32_t)?)|wchar_t|'
431 r'bool|short|int|long|signed|unsigned|float|double|'
432 # [support.types]
433 r'(ptrdiff_t|size_t|max_align_t|nullptr_t)|'
434 # [cstdint.syn]
435 r'(u?int(_fast|_least)?(8|16|32|64)_t)|'
436 r'(u?int(max|ptr)_t)|'
440 # These headers are excluded from [build/include] and [build/include_order]
441 # checks:
442 # - Anything not following google file name conventions (containing an
443 # uppercase character, such as Python.h or nsStringAPI.h, for example).
444 # - Lua headers.
448 # Pattern for matching FileInfo.BaseName() against test file name
451 # Pattern that matches only complete whitespace, possibly across multiple lines.
454 # Assertion macros. These are defined in base/logging.h and
455 # testing/base/public/gunit.h.
456 _CHECK_MACROS = [
460 ]
462 # Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE
479 # Alternative tokens and their replacements. For full list, see section 2.5
480 # Alternative tokens [lex.digraph] in the C++ standard.
481 #
482 # Digraphs (such as '%:') are not included here since it's a mess to
483 # match those on a word boundary.
484 _ALT_TOKEN_REPLACEMENT = {
496 }
498 # Compile regular expression that matches all the above keywords. The "[ =()]"
499 # bit is meant to avoid matching these keywords outside of boolean expressions.
500 #
501 # False positives include C-style multi-line comments and multi-line strings
502 # but those have always been troublesome for cpplint.
507 # These constants define types of headers for use with
508 # _IncludeState.CheckNextIncludeOrder().
515 # These constants define the current inline assembly state
521 # Match start of assembly blocks
523 r'(?:\s+(volatile|__volatile__))?'
526 # Match strings that indicate we're working on a C (not C++) file.
530 # Match string that indicates we're working on a Linux Kernel file.
533 _regexp_compile_cache = {}
535 # {str, set(int)}: a map from error categories to sets of linenumbers
536 # on which those errors are expected and should be suppressed.
537 _error_suppressions = {}
539 # The root directory used for deriving header guard CPP variable.
540 # This is set by --root flag.
543 # The allowed line length of files.
544 # This is set by --linelength flag.
547 # The allowed extensions for file names
548 # This is set by --extensions flag.
551 # Treat all headers starting with 'h' equally: .h, .hpp, .hxx etc.
552 # This is set by --headers flag.
555 # {str, bool}: a map from error categories to booleans which indicate if the
556 # category should be suppressed for every line.
557 _global_error_suppressions = {}
560 global _hpp_headers
563 # Automatically append to extensions list so it does not have to be set 2 times
572 """Updates the global list of line error-suppressions.
574 Parses any NOLINT comments on the current line, updating the global
575 error_suppressions store. Reports an error if the NOLINT comment
576 was malformed.
578 Args:
579 filename: str, the name of the input file.
580 raw_line: str, the line of input text, with comments.
581 linenum: int, the number of the current line.
582 error: function, an error handler.
583 """
589 suppressed_line = linenum
604 """Updates the list of global error suppressions.
606 Parses any lint directives in the file that have global effect.
608 Args:
609 lines: An array of strings, each representing a line of the file, with the
610 last element being empty if the file is terminated with a newline.
611 """
622 """Resets the set of NOLINT suppressions to empty."""
628 """Returns true if the specified error category is suppressed on this line.
630 Consults the global error_suppressions map populated by
631 ParseNolintSuppressions/ProcessGlobalSuppresions/ResetNolintSuppressions.
633 Args:
634 category: str, the category of the error.
635 linenum: int, the current line number.
636 Returns:
637 bool, True iff the error should be suppressed due to a NOLINT comment or
638 global suppression.
639 """
646 """Matches the string with the pattern, caching the compiled regexp."""
647 # The regexp compilation caching is inlined in both Match and Search for
648 # performance reasons; factoring it out into a separate function turns out
649 # to be noticeably expensive.
656 """Replaces instances of pattern in a string with a replacement.
658 The compiled regex is kept in a cache shared by Match and Search.
660 Args:
661 pattern: regex pattern
662 rep: replacement text
663 s: search string
665 Returns:
666 string with replacements made (or original string if no replacements)
667 """
674 """Searches the string for the pattern, caching the compiled regexp."""
681 """File extension (excluding dot) matches a source file extension."""
686 """Tracks line numbers for includes, and the order in which includes appear.
688 include_list contains list of lists of (header, line number) pairs.
689 It's a lists of lists rather than just one flat list to make it
690 easier to update across preprocessor boundaries.
692 Call CheckNextIncludeOrder() once for each header in the file, passing
693 in the type constants defined above. Calls in an illegal order will
694 raise an _IncludeError with an appropriate error message.
696 """
697 # self._section will move monotonically through this set. If it ever
698 # needs to move backwards, CheckNextIncludeOrder will raise an error.
705 _TYPE_NAMES = {
711 }
712 _SECTION_NAMES = {
718 }
725 """Check if a header has already been included.
727 Args:
728 header: header to check.
729 Returns:
730 Line number of previous occurrence, or -1 if the header has not
731 been seen before.
732 """
740 """Reset section checking for preprocessor directive.
742 Args:
743 directive: preprocessor directive (e.g. "if", "else").
744 """
745 # The name of the current section.
747 # The path of last found header.
750 # Update list of includes. Note that we never pop from the
751 # include list.
761 """Returns a path canonicalized for alphabetical comparison.
763 - replaces "-" with "_" so they both cmp the same.
764 - removes '-inl' since we don't require them to be after the main header.
765 - lowercase everything, just in case.
767 Args:
768 header_path: Path to be canonicalized.
770 Returns:
771 Canonicalized path.
772 """
776 """Check if a header is in alphabetical order with the previous header.
778 Args:
779 clean_lines: A CleansedLines instance containing the file.
780 linenum: The number of the line to check.
781 header_path: Canonicalized header to be checked.
783 Returns:
784 Returns true if the header is in alphabetical order.
785 """
786 # If previous section is different from current section, _last_header will
787 # be reset to empty string, so it's always less than current header.
788 #
789 # If previous line was a blank line, assume that the headers are
790 # intentionally sorted the way they are.
793 return False
794 return True
797 """Returns a non-empty error message if the next header is out of order.
799 This function also updates the internal state to be ready to check
800 the next include.
802 Args:
803 header_type: One of the _XXX_HEADER constants defined above.
805 Returns:
806 The empty string if the header is in the right order, or an
807 error message describing what's wrong.
809 """
821 return error_message
827 return error_message
837 # This will always be the fallback because we're not sure
838 # enough that the header is associated with this file.
851 """Maintains module-wide state.."""
856 # filters to apply when emitting error messages
858 # backup of filter list. Used to restore the state after each file.
863 # output format:
864 # "emacs" - format that emacs can parse (default)
865 # "vs7" - format that Microsoft Visual Studio 7 can parse
869 """Sets the output format for errors."""
873 """Sets the module's verbosity, and returns the previous setting."""
876 return last_verbose_level
879 """Sets the module's counting options."""
883 """Sets the error-message filters.
885 These filters are applied when deciding whether to emit a given
886 error message.
888 Args:
889 filters: A string of comma-separated filters (eg "+whitespace/indent").
890 Each filter should start with + or -; else we die.
892 Raises:
893 ValueError: The comma-separated filters did not all start with '+' or '-'.
894 E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter"
895 """
896 # Default filters always have less priority than the flag ones.
901 """ Adds more filters to the existing list of error-message filters. """
912 """ Saves the current filter list to backup storage."""
916 """ Restores filters previously backed up."""
920 """Sets the module's error statistic back to zero."""
925 """Bumps the module's error statistic."""
935 """Print a summary of errors by category, and the total."""
945 """Gets the module's output format."""
950 """Sets the module's output format."""
955 """Returns the module's verbosity setting."""
960 """Sets the module's verbosity, and returns the previous setting."""
965 """Sets the module's counting options."""
970 """Returns the module's list of output filters, as a list."""
975 """Sets the module's error-message filters.
977 These filters are applied when deciding whether to emit a given
978 error message.
980 Args:
981 filters: A string of comma-separated filters (eg "whitespace/indent").
982 Each filter should start with + or -; else we die.
983 """
987 """Adds more filter overrides.
989 Unlike _SetFilters, this function does not reset the current list of filters
990 available.
992 Args:
993 filters: A string of comma-separated filters (eg "whitespace/indent").
994 Each filter should start with + or -; else we die.
995 """
999 """ Saves the current filter list to backup storage."""
1003 """ Restores filters previously backed up."""
1007 """Tracks current function name and the number of lines in its body."""
1018 """Start analyzing function body.
1020 Args:
1021 function_name: The name of the function being tracked.
1022 """
1028 """Count line in current function body."""
1033 """Report if too many lines in function body.
1035 Args:
1036 error: The function to call with any errors found.
1037 filename: The name of the current file.
1038 linenum: The number of the line to check.
1039 """
1041 return
1051 # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ...
1055 'Small and focused functions are preferred:'
1061 """Stop analyzing function body."""
1066 """Indicates a problem with the include order in a file."""
1067 pass
1071 """Provides utility functions for filenames.
1073 FileInfo provides easy access to the components of a file's path
1074 relative to the project root.
1075 """
1081 """Make Windows paths like Unix."""
1085 """FullName after removing the local path to the repository.
1087 If we have a real absolute path name here we can try to do something smart:
1088 detecting the root of the checkout and truncating /path/to/checkout from
1089 the name so that we get header guards that don't include things like
1090 "C:\Documents and Settings\..." or "/home/username/..." in them and thus
1091 people on different computers who have checked the source out to different
1092 locations won't see bogus errors.
1093 """
1100 # If there's a .svn file in the current directory, we recursively look
1101 # up the directory tree for the top of the SVN checkout
1102 root_dir = project_dir
1111 # Not SVN <= 1.6? Try to find a git, hg, or svn top level directory by
1112 # searching up from the current path.
1118 root_dir = current_dir
1127 # Don't know what to do; header guard warnings may be wrong...
1128 return fullname
1131 """Splits the file into the directory, basename, and extension.
1133 For 'chrome/browser/browser.cc', Split() would
1134 return ('chrome/browser', 'browser', '.cc')
1136 Returns:
1137 A tuple of (directory, basename, extension).
1138 """
1145 """File base name - text after the final slash, before the final period."""
1149 """File extension - text following the final period."""
1153 """File has no source file extension."""
1157 """File has a source file extension."""
1162 """If confidence >= verbose, category passes filter and is not suppressed."""
1164 # There are three ways we might decide not to print an error message:
1165 # a "NOLINT(category)" comment appears in the source,
1166 # the verbosity level isn't high enough, or the filters filter it out.
1168 return False
1171 return False
1184 return False
1186 return True
1190 """Logs the fact we've found a lint error.
1192 We log where the error was found, and also our confidence in the error,
1193 that is, how certain we are this is a legitimate style regression, and
1194 not a misidentification or a use that's sometimes justified.
1196 False positives can be suppressed by the use of
1197 "cpplint(category)" comments on the offending line. These are
1198 parsed into _error_suppressions.
1200 Args:
1201 filename: The name of the file containing the error.
1202 linenum: The number of the line containing the error.
1203 category: A string used to describe the "category" this bug
1204 falls under: "whitespace", say, or "runtime". Categories
1205 may have a hierarchy separated by slashes: "whitespace/indent".
1206 confidence: A number from 1-5 representing a confidence score for
1207 the error, with 5 meaning that we are certain of the problem,
1208 and 1 meaning that it could be a legitimate construct.
1209 message: The error message.
1210 """
1224 # Matches standard C++ escape sequences per 2.13.2.3 of the C++ standard.
1227 # Match a single C style comment on the same line.
1229 # Matches multi-line C style comments.
1230 # This RE is a little bit more complicated than one might expect, because we
1231 # have to take care of space removals tools so we can handle comments inside
1232 # statements better.
1233 # The current rule is: We only clear spaces from both sides when we're at the
1234 # end of the line. Otherwise, we try to remove spaces from the right side,
1235 # if this doesn't work we try on left side but only if there's a non-character
1236 # on the right.
1245 """Does line terminate so, that the next symbol is in string constant.
1247 This function does not consider single-line nor multi-line comments.
1249 Args:
1250 line: is a partial line of code starting from the 0..n.
1252 Returns:
1253 True, if next character appended to 'line' is inside a
1254 string constant.
1255 """
1262 """Removes C++11 raw strings from lines.
1264 Before:
1265 static const char kData[] = R"(
1266 multi-line string
1267 )";
1269 After:
1270 static const char kData[] = ""
1271 (replaced by blank line)
1272 "";
1274 Args:
1275 raw_lines: list of raw lines.
1277 Returns:
1278 list of lines with C++11 raw strings replaced by empty strings.
1279 """
1282 lines_without_raw_strings = []
1285 # Inside a raw string, look for the end
1288 # Found the end of the string, match leading space for this
1289 # line and resume copying the original lines, and also insert
1290 # a "" on the last line.
1295 # Haven't found the end yet, append a blank line.
1298 # Look for beginning of a raw string, and replace them with
1299 # empty strings. This is done in a loop to handle multiple raw
1300 # strings on the same line.
1302 # Look for beginning of a raw string.
1303 # See 2.14.15 [lex.string] for syntax.
1304 #
1305 # Once we have matched a raw string, we check the prefix of the
1306 # line to make sure that the line is not part of a single line
1307 # comment. It's done this way because we remove raw strings
1308 # before removing comments as opposed to removing comments
1309 # before removing raw strings. This is because there are some
1310 # cpplint checks that requires the comments to be preserved, but
1311 # we don't want to check comments that are inside raw strings.
1315 matched.group(1))):
1318 end = matched.group(3).find(delimiter)
1319 if end >= 0:
1320 # Raw string ended on same line
1322 matched.group(3)[end + len(delimiter):])
1323 delimiter = None
1324 else:
1325 # Start of a multi-line raw string
1327 else:
1328 break
1330 lines_without_raw_strings.append(line)
1332 # TODO(unknown): if delimiter is not None here, we might want to
1333 # emit a warning for unterminated string.
1334 return lines_without_raw_strings
1337 def FindNextMultiLineCommentStart(lines, lineix):
1338 """Find the beginning marker for a multiline comment."""
1339 while lineix < len(lines):
1340 if lines[lineix].strip().startswith('/*'):
1341 # Only return this marker if the comment goes beyond this line
1342 if lines[lineix].strip().find('*/', 2) < 0:
1343 return lineix
1344 lineix += 1
1345 return len(lines)
1348 def FindNextMultiLineCommentEnd(lines, lineix):
1349 """We are inside a comment, find the end marker."""
1350 while lineix < len(lines):
1351 if lines[lineix].strip().endswith('*/'):
1352 return lineix
1353 lineix += 1
1354 return len(lines)
1357 def RemoveMultiLineCommentsFromRange(lines, begin, end):
1358 """Clears a range of lines for multi-line comments."""
1359 # Having // dummy comments makes the lines non-empty, so we will not get
1360 # unnecessary blank line warnings later in the code.
1361 for i in range(begin, end):
1362 lines[i] = '/**/'
1365 def RemoveMultiLineComments(filename, lines, error):
1366 """Removes multiline (c-style) comments from lines."""
1367 lineix = 0
1368 while lineix < len(lines):
1369 lineix_begin = FindNextMultiLineCommentStart(lines, lineix)
1370 if lineix_begin >= len(lines):
1371 return
1372 lineix_end = FindNextMultiLineCommentEnd(lines, lineix_begin)
1373 if lineix_end >= len(lines):
1374 error(filename, lineix_begin + 1, 'readability/multiline_comment', 5,
1375 'Could not find end of multi-line comment')
1376 return
1377 RemoveMultiLineCommentsFromRange(lines, lineix_begin, lineix_end + 1)
1378 lineix = lineix_end + 1
1381 def CleanseComments(line):
1382 """Removes //-comments and single-line C-style /* */ comments.
1384 Args:
1385 line: A line of C++ source.
1387 Returns:
1388 The line with single-line comments removed.
1389 """
1390 commentpos = line.find('//')
1391 if commentpos != -1 and not IsCppString(line[:commentpos]):
1392 line = line[:commentpos].rstrip()
1393 # get rid of /* ... */
1394 return _RE_PATTERN_CLEANSE_LINE_C_COMMENTS.sub('', line)
1397 class CleansedLines(object):
1398 """Holds 4 copies of all lines with different preprocessing applied to them.
1400 1) elided member contains lines without strings and comments.
1401 2) lines member contains lines without comments.
1402 3) raw_lines member contains all the lines without processing.
1403 4) lines_without_raw_strings member is same as raw_lines, but with C++11 raw
1404 strings removed.
1405 All these members are of <type 'list'>, and of the same length.
1406 """
1408 def __init__(self, lines):
1409 self.elided = []
1410 self.lines = []
1411 self.raw_lines = lines
1412 self.num_lines = len(lines)
1413 self.lines_without_raw_strings = CleanseRawStrings(lines)
1414 for linenum in range(len(self.lines_without_raw_strings)):
1415 self.lines.append(CleanseComments(
1416 self.lines_without_raw_strings[linenum]))
1417 elided = self._CollapseStrings(self.lines_without_raw_strings[linenum])
1418 self.elided.append(CleanseComments(elided))
1420 def NumLines(self):
1421 """Returns the number of lines represented."""
1422 return self.num_lines
1424 @staticmethod
1425 def _CollapseStrings(elided):
1430 Args:
1431 elided: The line being processed.
1433 Returns:
1434 The line with collapsed strings.
1435 """
1436 if _RE_PATTERN_INCLUDE.match(elided):
1437 return elided
1439 # Remove escaped characters first to make quote/single quote collapsing
1440 # basic. Things that look like escaped characters shouldn't occur
1441 # outside of strings and chars.
1442 elided = _RE_PATTERN_CLEANSE_LINE_ESCAPES.sub('', elided)
1444 # Replace quoted strings and digit separators. Both single quotes
1445 # and double quotes are processed in the same loop, otherwise
1446 # nested quotes wouldn't work.
1447 collapsed = ''
1448 while True:
1449 # Find the first quote character
1451 if not match:
1452 collapsed += elided
1453 break
1454 head, quote, tail = match.groups()
1457 # Collapse double quoted strings
1459 if second_quote >= 0:
1461 elided = tail[second_quote + 1:]
1462 else:
1463 # Unmatched double quote, don't bother processing the rest
1464 # of the line since this is probably a multiline string.
1465 collapsed += elided
1466 break
1467 else:
1468 # Found single quote, check nearby text to eliminate digit separators.
1469 #
1470 # There is no special handling for floating point here, because
1471 # the integer/fractional/exponent parts would all be parsed
1472 # correctly as long as there are digits on both sides of the
1473 # separator. So we are fine as long as we don't see something
1478 elided = match_literal.group(2)
1479 else:
1481 if second_quote >= 0:
1483 elided = tail[second_quote + 1:]
1484 else:
1485 # Unmatched single quote
1486 collapsed += elided
1487 break
1489 return collapsed
1492 def FindEndOfExpressionInLine(line, startpos, stack):
1493 """Find the position just after the end of current parenthesized expression.
1495 Args:
1496 line: a CleansedLines line.
1497 startpos: start searching at this position.
1498 stack: nesting stack at startpos.
1500 Returns:
1501 On finding matching end: (index just after matching end, None)
1502 On finding an unclosed expression: (-1, None)
1503 Otherwise: (-1, new stack at end of this line)
1504 """
1505 for i in xrange(startpos, len(line)):
1506 char = line[i]
1508 # Found start of parenthesized expression, push to expression stack
1509 stack.append(char)
1511 # Found potential start of template argument list
1513 # Left shift operator
1515 stack.pop()
1516 if not stack:
1517 return (-1, None)
1519 # operator<, don't add to stack
1520 continue
1522 # Tentative start of template argument list
1525 # Found end of parenthesized expression.
1526 #
1527 # If we are currently expecting a matching '>', the pending '<'
1528 # must have been an operator. Remove them from expression stack.
1540 # Mismatched parentheses
1543 # Found potential end of template argument list.
1545 # Ignore "->" and operator functions
1548 continue
1550 # Pop the stack if there is a matching '<'. Otherwise, ignore
1551 # this '>' since it must be an operator.
1558 # Found something that look like end of statements. If we are currently
1559 # expecting a '>', the matching '<' must have been an operator, since
1560 # template argument list should not contain statements.
1566 # Did not find end of expression or unbalanced parentheses on this line
1571 """If input points to ( or { or [ or <, finds the position that closes it.
1573 If lines[linenum][pos] points to a '(' or '{' or '[' or '<', finds the
1574 linenum/pos that correspond to the closing of the expression.
1576 TODO(unknown): cpplint spends a fair bit of time matching parentheses.
1577 Ideally we would want to index all opening and closing parentheses once
1578 and have CloseExpression be just a simple lookup, but due to preprocessor
1579 tricks, this is not so easy.
1581 Args:
1582 clean_lines: A CleansedLines instance containing the file.
1583 linenum: The number of the line to check.
1584 pos: A position on the line.
1586 Returns:
1587 A tuple (line, linenum, pos) pointer *past* the closing brace, or
1588 (line, len(lines), -1) if we never find a close. Note we ignore
1589 strings and comments when matching; and the line we return is the
1590 'cleansed' line at linenum.
1591 """
1597 # Check first line
1602 # Continue scanning forward
1610 # Did not find end of expression before end of file, give up
1615 """Find position at the matching start of current expression.
1617 This is almost the reverse of FindEndOfExpressionInLine, but note
1618 that the input position and returned position differs by 1.
1620 Args:
1621 line: a CleansedLines line.
1622 endpos: start searching at this position.
1623 stack: nesting stack at endpos.
1625 Returns:
1626 On finding matching start: (index at matching start, None)
1627 On finding an unclosed expression: (-1, None)
1628 Otherwise: (-1, new stack at beginning of this line)
1629 """
1630 i = endpos
1634 # Found end of expression, push to expression stack
1637 # Found potential end of template argument list.
1638 #
1639 # Ignore it if it's a "->" or ">=" or "operator>"
1648 # Found potential start of template argument list
1650 # Left shift operator
1653 # If there is a matching '>', we can pop the expression stack.
1654 # Otherwise, ignore this '<' since it must be an operator.
1660 # Found start of expression.
1661 #
1662 # If there are any unmatched '>' on the stack, they must be
1663 # operators. Remove those.
1675 # Mismatched parentheses
1678 # Found something that look like end of statements. If we are currently
1679 # expecting a '<', the matching '>' must have been an operator, since
1680 # template argument list should not contain statements.
1692 """If input points to ) or } or ] or >, finds the position that opens it.
1694 If lines[linenum][pos] points to a ')' or '}' or ']' or '>', finds the
1695 linenum/pos that correspond to the opening of the expression.
1697 Args:
1698 clean_lines: A CleansedLines instance containing the file.
1699 linenum: The number of the line to check.
1700 pos: A position on the line.
1702 Returns:
1703 A tuple (line, linenum, pos) pointer *at* the opening brace, or
1704 (line, 0, -1) if we never find the matching opening brace. Note
1705 we ignore strings and comments when matching; and the line we
1706 return is the 'cleansed' line at linenum.
1707 """
1712 # Check last line
1717 # Continue scanning backward
1725 # Did not find start of expression before beginning of file, give up
1730 """Logs an error if no Copyright message appears at the top of the file."""
1732 # We'll say it should occur by line 10. Don't forget there's a
1733 # dummy line at the front.
1738 'No copyright message found. '
1743 """Return the number of leading spaces in line.
1745 Args:
1746 line: A string to check.
1748 Returns:
1749 An integer count of leading spaces, possibly zero.
1750 """
1759 """Returns the CPP variable that should be used as a header guard.
1761 Args:
1762 filename: The name of a C++ header file.
1764 Returns:
1765 The CPP variable that should be used as a header guard in the
1766 named file.
1768 """
1770 # Restores original filename in case that cpplint is invoked from Emacs's
1771 # flymake.
1774 # Replace 'c++' with 'cpp'.
1781 # On Windows using directory separator will leave us with
1782 # "bogus escape error" unless we properly escape regex.
1790 """Checks that the file contains a header guard.
1792 Logs an error if no #ifndef header guard is present. For other
1793 headers, checks that the full pathname is used.
1795 Args:
1796 filename: The name of the C++ header file.
1797 clean_lines: A CleansedLines instance containing the file.
1798 error: The function to call with any errors found.
1799 """
1801 # Don't check for header guards if there are error suppression
1802 # comments somewhere in this file.
1803 #
1804 # Because this is silencing a warning for a nonexistent line, we
1805 # only support the very specific NOLINT(build/header_guard) syntax,
1806 # and not the general NOLINT or NOLINT(*) syntax.
1810 return
1822 # find the first occurrence of #ifndef and #define, save arg
1824 # set ifndef to the header guard presented on the #ifndef line.
1826 ifndef_linenum = linenum
1829 # find the last occurrence of #endif, save entire line
1831 endif = line
1832 endif_linenum = linenum
1837 cppvar)
1838 return
1840 # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__
1841 # for backward compatibility.
1848 error)
1852 # Check for "//" comments on endif line.
1854 error)
1858 # Issue low severity warning for deprecated double trailing underscore
1861 return
1863 # Didn't find the corresponding "//" comment. If this file does not
1864 # contain any "//" comments at all, it could be that the compiler
1865 # only wants "/**/" comments, look for those instead.
1870 no_single_line_comments = False
1871 break
1873 if no_single_line_comments:
1877 # Low severity warning for double trailing underscore
1880 return
1882 # Didn't find anything
1888 """Logs an error if a .cc file does not include its header."""
1890 # Do not check test files
1893 return
1897 return
1903 return
1909 headername))
1913 """Logs an error for each line containing bad characters.
1915 Two kinds of bad characters:
1917 1. Unicode replacement characters: These indicate that either the file
1918 contained invalid UTF-8 (likely) or Unicode replacement characters (which
1919 it shouldn't). Note that it's possible for this to throw off line
1920 numbering if the invalid UTF-8 occurred adjacent to a newline.
1922 2. NUL bytes. These are problematic for some tools.
1924 Args:
1925 filename: The name of the current file.
1926 lines: An array of strings, each representing a line of the file.
1927 error: The function to call with any errors found.
1928 """
1938 """Logs an error if there is no newline char at the end of the file.
1940 Args:
1941 filename: The name of the current file.
1942 lines: An array of strings, each representing a line of the file.
1943 error: The function to call with any errors found.
1944 """
1946 # The array lines() was created by adding two newlines to the
1947 # original file (go figure), then splitting on \n.
1948 # To verify that the file ends in \n, we just have to make sure the
1949 # last-but-two element of lines() exists and is empty.
1956 """Logs an error if we see /* ... */ or "..." that extend past one line.
1958 /* ... */ comments are legit inside macros, for one line.
1959 Otherwise, we prefer // comments, so it's ok to warn about the
1960 other. Likewise, it's ok for strings to extend across multiple
1961 lines, as long as a line continuation character (backslash)
1962 terminates each line. Although not currently prohibited by the C++
1963 style guide, it's ugly and unnecessary. We don't do well with either
1964 in this lint program, so we warn about both.
1966 Args:
1967 filename: The name of the current file.
1968 clean_lines: A CleansedLines instance containing the file.
1969 linenum: The number of the line to check.
1970 error: The function to call with any errors found.
1971 """
1974 # Remove all \\ (escaped backslashes) from the line. They are OK, and the
1975 # second (escaped) slash may trigger later \" detection erroneously.
1980 'Complex multi-line /*...*/-style comment found. '
1981 'Lint may give bogus warnings. '
1982 'Consider replacing these with //-style comments, '
1983 'with #if 0...#endif, '
1989 'do well with such strings, and may give bogus warnings. '
1993 # (non-threadsafe name, thread-safe alternative, validation pattern)
1994 #
1995 # The validation pattern is used to eliminate false positives such as:
1996 # _rand(); // false positive due to substring match.
1997 # ->rand(); // some member function rand().
1998 # ACMRandom rand(seed); // some variable named rand.
1999 # ISAACRandom rand(); // another variable named rand.
2000 #
2001 # Basically we require the return value of these functions to be used
2002 # in some expression context on the same line by matching on some
2003 # operator before the function name. This eliminates constructors and
2004 # member function calls.
2006 _THREADING_LIST = (
2020 )
2024 """Checks for calls to thread-unsafe functions.
2026 Much code has been originally written without consideration of
2027 multi-threading. Also, engineers are relying on their old experience;
2028 they have learned posix before threading extensions were added. These
2029 tests guide the engineers to use thread-safe functions (when using
2030 posix directly).
2032 Args:
2033 filename: The name of the current file.
2034 clean_lines: A CleansedLines instance containing the file.
2035 linenum: The number of the line to check.
2036 error: The function to call with any errors found.
2037 """
2040 # Additional pattern matching check to confirm that this is the
2041 # function we are looking for
2050 """Checks that VLOG() is only used for defining a logging level.
2052 For example, VLOG(2) is correct. VLOG(INFO), VLOG(WARNING), VLOG(ERROR), and
2053 VLOG(FATAL) are not.
2055 Args:
2056 filename: The name of the current file.
2057 clean_lines: A CleansedLines instance containing the file.
2058 linenum: The number of the line to check.
2059 error: The function to call with any errors found.
2060 """
2064 'VLOG() should be used with numeric verbosity level. '
2067 # Matches invalid increment: *count++, which moves pointer instead of
2068 # incrementing a value.
2074 """Checks for invalid increment *count++.
2076 For example following function:
2077 void increment_counter(int* count) {
2078 *count++;
2079 }
2080 is invalid, because it effectively does count++, moving pointer, and should
2081 be replaced with ++*count, (*count)++ or *count += 1.
2083 Args:
2084 filename: The name of the current file.
2085 clean_lines: A CleansedLines instance containing the file.
2086 linenum: The number of the line to check.
2087 error: The function to call with any errors found.
2088 """
2097 return True
2100 return True
2102 return False
2110 """Stores information about a generic block of code."""
2120 """Run checks that applies to text up to the opening brace.
2122 This is mostly for checking the text after the class identifier
2123 and the "{", usually where the base class is specified. For other
2124 blocks, there isn't much to check, so we always pass.
2126 Args:
2127 filename: The name of the current file.
2128 clean_lines: A CleansedLines instance containing the file.
2129 linenum: The number of the line to check.
2130 error: The function to call with any errors found.
2131 """
2132 pass
2135 """Run checks that applies to text after the closing brace.
2137 This is mostly used for checking end of namespace comments.
2139 Args:
2140 filename: The name of the current file.
2141 clean_lines: A CleansedLines instance containing the file.
2142 linenum: The number of the line to check.
2143 error: The function to call with any errors found.
2144 """
2145 pass
2148 """Returns true if this block is a _BlockInfo.
2150 This is convenient for verifying that an object is an instance of
2151 a _BlockInfo, but not an instance of any of the derived classes.
2153 Returns:
2154 True for this class, False for derived classes.
2155 """
2160 """Stores information about an 'extern "C"' block."""
2167 """Stores information about a class."""
2181 # Remember initial indentation level for this class. Using raw_lines here
2182 # instead of elided to account for leading comments.
2185 # Try to find the end of the class. This will be confused by things like:
2186 # class A {
2187 # } *x = { ...
2188 #
2189 # But it's still good enough for CheckSectionSpacing.
2197 break
2200 # Look for a bare ':'
2205 # If there is a DISALLOW macro, it should appear near the end of
2206 # the class.
2217 break
2222 # Check that closing brace is aligned with beginning of the class.
2223 # Only do this if the closing brace is indented by only whitespaces.
2224 # This means we will not check single-line class definitions.
2236 """Stores information about a namespace."""
2244 """Check end of namespace comments."""
2247 # Check how many lines is enclosed in this namespace. Don't issue
2248 # warning for missing namespace comments if there aren't enough
2249 # lines. However, do apply checks if there is already an end of
2250 # namespace comment and it's incorrect.
2251 #
2252 # TODO(unknown): We always want to check end of namespace comments
2253 # if a namespace is large, but sometimes we also want to apply the
2254 # check if a short namespace contained nontrivial things (something
2255 # other than forward declarations). There is currently no logic on
2256 # deciding what these nontrivial things are, so this check is
2257 # triggered by namespace size only, which works most of the time.
2260 return
2262 # Look for matching comment at end of namespace.
2263 #
2264 # Note that we accept C style "/* */" comments for terminating
2265 # namespaces, so that code that terminate namespaces inside
2266 # preprocessor macros can be cpplint clean.
2267 #
2268 # We also accept stuff like "// end of namespace <name>." with the
2269 # period at the end.
2270 #
2271 # Besides these, we don't accept anything else, otherwise we might
2272 # get false negatives when existing comment is a substring of the
2273 # expected namespace.
2275 # Named namespace
2278 line):
2283 # Anonymous namespace
2285 # If "// namespace anonymous" or "// anonymous namespace (more text)",
2286 # mention "// anonymous namespace" as an acceptable form
2289 'Anonymous namespace should be terminated with "// namespace"'
2297 """Stores checkpoints of nesting stacks when #if/#else is seen."""
2300 # The entire nesting stack before #if
2303 # The entire nesting stack up to #else
2306 # Whether we have already seen #else or #elif
2311 """Holds states related to parsing braces."""
2314 # Stack for tracking all braces. An object is pushed whenever we
2315 # see a "{", and popped when we see a "}". Only 3 types of
2316 # objects are possible:
2317 # - _ClassInfo: a class or struct.
2318 # - _NamespaceInfo: a namespace.
2319 # - _BlockInfo: some other type of block.
2322 # Top of the previous stack before each Update().
2323 #
2324 # Because the nesting_stack is updated at the end of each line, we
2325 # had to do some convoluted checks to find out what is the current
2326 # scope at the beginning of the line. This check is simplified by
2327 # saving the previous top of nesting stack.
2328 #
2329 # We could save the full stack, but we only need the top. Copying
2330 # the full nesting stack would slow down cpplint by ~10%.
2333 # Stack of _PreprocessorInfo objects.
2337 """Check if we have seen the opening brace for the innermost block.
2339 Returns:
2340 True if we have seen the opening brace, False if the innermost
2341 block is still expecting an opening brace.
2342 """
2346 """Check if we are currently one level inside a namespace body.
2348 Returns:
2349 True if top of the stack is a namespace block, False otherwise.
2350 """
2354 """Check if we are currently one level inside an 'extern "C"' block.
2356 Returns:
2357 True if top of the stack is an extern block, False otherwise.
2358 """
2362 """Check if we are currently one level inside a class or struct declaration.
2364 Returns:
2365 True if top of the stack is a class/struct, False otherwise.
2366 """
2370 """Check if we are currently one level inside an inline ASM block.
2372 Returns:
2373 True if the top of the stack is a block containing inline ASM.
2374 """
2378 """Check if current position is inside template argument list.
2380 Args:
2381 clean_lines: A CleansedLines instance containing the file.
2382 linenum: The number of the line to check.
2383 pos: position just after the suspected template argument.
2384 Returns:
2385 True if (linenum, pos) is inside template arguments.
2386 """
2388 # Find the earliest character that might indicate a template argument
2394 continue
2398 # These things do not look like template argument list:
2399 # class Suspect {
2400 # class Suspect x; }
2403 # These things look like template argument list:
2404 # template <class Suspect>
2405 # template <class Suspect = default_value>
2406 # template <class Suspect[]>
2407 # template <class Suspect...>
2410 # Check if token is an unmatched '<'.
2411 # If not, move on to the next character.
2417 continue
2419 # We can't be sure if we just find a single '<', and need to
2420 # find the matching '>'.
2423 # Not sure if template argument list or syntax error in file
2424 return False
2425 linenum = end_line
2426 pos = end_pos
2427 return False
2430 """Update preprocessor stack.
2432 We need to handle preprocessors due to classes like this:
2433 #ifdef SWIG
2434 struct ResultDetailsPageElementExtensionPoint {
2435 #else
2436 struct ResultDetailsPageElementExtensionPoint : public Extension {
2437 #endif
2439 We make the following assumptions (good enough for most files):
2440 - Preprocessor condition evaluates to true from #if up to first
2441 #else/#elif/#endif.
2443 - Preprocessor condition evaluates to false from #else/#elif up
2444 to #endif. We still perform lint checks on these lines, but
2445 these do not affect nesting stack.
2447 Args:
2448 line: current line to check.
2449 """
2451 # Beginning of #if block, save the nesting stack here. The saved
2452 # stack will allow us to restore the parsing state in the #else case.
2455 # Beginning of #else block
2458 # This is the first #else or #elif block. Remember the
2459 # whole nesting stack up to this point. This is what we
2460 # keep after the #endif.
2464 # Restore the stack to how it was before the #if
2467 # TODO(unknown): unexpected #else, issue warning?
2468 pass
2470 # End of #if or #else blocks.
2472 # If we saw an #else, we will need to restore the nesting
2473 # stack to its former state before the #else, otherwise we
2474 # will just continue from where we left off.
2476 # Here we can just use a shallow copy since we are the last
2477 # reference to it.
2479 # Drop the corresponding #if
2482 # TODO(unknown): unexpected #endif, issue warning?
2483 pass
2485 # TODO(unknown): Update() is too long, but we will refactor later.
2487 """Update nesting state with current line.
2489 Args:
2490 filename: The name of the current file.
2491 clean_lines: A CleansedLines instance containing the file.
2492 linenum: The number of the line to check.
2493 error: The function to call with any errors found.
2494 """
2497 # Remember top of the previous nesting stack.
2498 #
2499 # The stack is always pushed/popped and not modified in place, so
2500 # we can just do a shallow copy instead of copy.deepcopy. Using
2501 # deepcopy would slow down cpplint by ~28%.
2507 # Update pp_stack
2510 # Count parentheses. This is to avoid adding struct arguments to
2511 # the nesting stack.
2517 # Also check if we are starting or ending an inline assembly block.
2522 # Enter assembly block
2525 # Not entering assembly block. If previous line was _END_ASM,
2526 # we will now shift to _NO_ASM state.
2530 # Exit assembly block
2533 # Consume namespace declaration at the beginning of the line. Do
2534 # this in a loop so that we catch same line declarations like this:
2535 # namespace proto2 { namespace bridge { class MessageSet; } }
2537 # Match start of namespace. The "\b\s*" below catches namespace
2538 # declarations even if it weren't followed by a whitespace, this
2539 # is so that we don't confuse our namespace checker. The
2540 # missing spaces will be flagged by CheckSpacing.
2543 break
2553 # Look for a class declaration in whatever is left of the line
2554 # after parsing namespaces. The regexp accounts for decorated classes
2555 # such as in:
2556 # class LOCKABLE API Object {
2557 # };
2559 r'^(\s*(?:template\s*<[\w\s<>,:]*>\s*)?'
2560 r'(class|struct)\s+(?:[A-Z_]+\s+)*(\w+(?:::\w+)*))'
2564 # We do not want to accept classes that are actually template arguments:
2565 # template <class Ignore1,
2566 # class Ignore2 = Default<Args>,
2567 # template <Args> class Ignore3>
2568 # void Function() {};
2569 #
2570 # To avoid template argument cases, we scan forward and look for
2571 # an unmatched '>'. If we see one, assume we are inside a
2572 # template argument list.
2580 # If we have not yet seen the opening brace for the innermost block,
2581 # run checks here.
2585 # Update access control if we are inside a class/struct
2589 r'^(.*)\b(public|private|protected|signals)(\s+(?:slots\s*)?)?'
2591 line)
2595 # Check that access keywords are indented +1 space. Skip this
2596 # check if the keywords are not preceded by whitespaces.
2611 # Consume braces or semicolons from what's left of the line
2613 # Match first brace, semicolon, or closed parenthesis.
2616 break
2620 # If namespace or class hasn't seen a opening brace yet, mark
2621 # namespace/class head as complete. Push a new block onto the
2622 # stack otherwise.
2633 # If we haven't seen an opening brace yet, but we already saw
2634 # a semicolon, this is probably a forward declaration. Pop
2635 # the stack for these.
2636 #
2637 # Similarly, if we haven't seen an opening brace yet, but we
2638 # already saw a closing parenthesis, then these are probably
2639 # function arguments with extra "class" or "struct" keywords.
2640 # Also pop these stack for these.
2644 # Perform end of block checks and pop the stack.
2651 """Get class info on the top of the stack.
2653 Returns:
2654 A _ClassInfo object if we are inside a class, or None otherwise.
2655 """
2659 return classinfo
2660 return None
2663 """Checks that all classes and namespaces have been completely parsed.
2665 Call this when all lines in a file have been processed.
2666 Args:
2667 filename: The name of the current file.
2668 error: The function to call with any errors found.
2669 """
2670 # Note: This test can result in false positives if #ifdef constructs
2671 # get in the way of brace matching. See the testBuildClass test in
2672 # cpplint_unittest.py for an example of this.
2686 r"""Logs an error if we see certain non-ANSI constructs ignored by gcc-2.
2688 Complain about several constructs which gcc-2 accepts, but which are
2689 not standard C++. Warning about these in lint is one way to ease the
2690 transition to new compilers.
2691 - put storage class first (e.g. "static const" instead of "const static").
2692 - "%lld" instead of %qd" in printf-type functions.
2693 - "%1$d" is non-standard in printf-type functions.
2694 - "\%" is an undefined character escape sequence.
2695 - text after #endif is not allowed.
2696 - invalid inner-style forward declaration.
2697 - >? and <? operators, and their >?= and <?= cousins.
2699 Additionally, check for constructor/destructor style violations and reference
2700 members, as it is very convenient to do so while checking for
2701 gcc-2 compliance.
2703 Args:
2704 filename: The name of the current file.
2705 clean_lines: A CleansedLines instance containing the file.
2706 linenum: The number of the line to check.
2707 nesting_state: A NestingState instance which maintains information about
2708 the current stack of nested blocks being parsed.
2709 error: A callable to which errors are reported, which takes 4 arguments:
2710 filename, line number, error level, and message
2711 """
2713 # Remove comments from the line, but leave in strings for now.
2724 # Remove escaped backslashes before looking for undefined escapes.
2731 # For the rest, work with both comments and strings removed.
2732 line = clean_lines.elided[linenum]
2738 line):
2752 line):
2757 # TODO(unknown): Could it be expanded safely to arbitrary references,
2758 # without triggering too many false positives? The first
2759 # attempt triggered 5 warnings for mostly benign code in the regtest, hence
2760 # the restriction.
2761 # Here's the original regexp, for the reference:
2762 # type_name = r'\w+((\s*::\s*\w+)|(\s*<\s*\w+?\s*>))?'
2763 # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;'
2765 'const string& members are dangerous. It is much better to use '
2768 # Everything else in this function operates on class declarations.
2769 # Return early if the top of the nesting stack is not a class, or if
2770 # the class head is not completed yet.
2773 return
2775 # The class may have been declared with namespace or classname qualifiers.
2776 # The constructor and destructor will not have those qualifiers.
2779 # Look for single-argument constructors that aren't marked explicit.
2780 # Technically a valid construct, but against style.
2782 r'\s+(?:(?:inline|constexpr)\s+)*(explicit\s+)?'
2784 r'\(((?:[^()]|\([^()]*\))*)\)'
2786 line)
2792 constructor_args = []
2796 # collapse arguments so that commas in template parameter lists and function
2797 # argument parameter lists don't split arguments in two
2810 # 'void' arg specifier
2815 # all but at most one arg defaulted
2820 onearg_constructor and
2823 onearg_constructor and
2828 onearg_constructor and
2833 'Constructors callable with one argument '
2845 """Checks for the correctness of various spacing around function calls.
2847 Args:
2848 filename: The name of the current file.
2849 clean_lines: A CleansedLines instance containing the file.
2850 linenum: The number of the line to check.
2851 error: The function to call with any errors found.
2852 """
2855 # Since function calls often occur inside if/for/while/switch
2856 # expressions - which have their own, more liberal conventions - we
2857 # first see if we should be looking inside such an expression for a
2858 # function call, to which we can apply more strict standards.
2867 break
2869 # Except in if/for/while/switch, there should never be space
2870 # immediately inside parens (eg "f( 3, 4 )"). We make an exception
2871 # for nested parens ( (a+b) + c ). Likewise, there should never be
2872 # a space before a ( when it's a function argument. I assume it's a
2873 # function argument when the char before the whitespace is legal in
2874 # a function name (alnum + _) and we're not starting a macro. Also ignore
2875 # pointers and references to arrays and functions coz they're too tricky:
2876 # we use a very simple way to recognize these:
2877 # " (something)(maybe-something)" or
2878 # " (something)(maybe-something," or
2879 # " (something)[something]"
2880 # Note that we assume the contents of [] to be short enough that
2881 # they'll never need to wrap.
2885 # Ignore pointers/references to functions.
2887 # Ignore pointers/references to arrays.
2900 # TODO(unknown): Space after an operator function seem to be a common
2901 # error, silence those for now by restricting them to highest verbosity.
2908 # If the ) is followed only by a newline or a { + newline, assume it's
2909 # part of a control statement (if/while/etc), and don't complain
2911 # If the closing parenthesis is preceded by only whitespaces,
2912 # try to give a more descriptive error message.
2922 """Returns true if the given line is blank.
2924 We consider a line to be blank if the line is empty or consists of
2925 only white spaces.
2927 Args:
2928 line: A line of a string.
2930 Returns:
2931 True, if the given line is blank.
2932 """
2937 error):
2938 is_namespace_indent_item = (
2952 """Reports for long function bodies.
2954 For an overview why this is done, see:
2955 https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions
2957 Uses a simplistic algorithm assuming other style guidelines
2958 (especially spacing) are followed.
2959 Only checks unindented functions, so class members are unchecked.
2960 Trivial bodies are unchecked, so constructors with huge initializer lists
2961 may be missed.
2962 Blank/comment lines are not counted so as to avoid encouraging the removal
2963 of vertical space and comments just to get through a lint check.
2964 NOLINT *on the last line of a function* disables this check.
2966 Args:
2967 filename: The name of the current file.
2968 clean_lines: A CleansedLines instance containing the file.
2969 linenum: The number of the line to check.
2970 function_state: Current function name and lines in body so far.
2971 error: The function to call with any errors found.
2972 """
2981 # If the name is all caps and underscores, figure it's a macro and
2982 # ignore it, unless it's TEST or TEST_F.
3006 break
3008 # No body for the function (or evidence of a non-function) was found.
3022 """Checks for common mistakes in comments.
3024 Args:
3025 line: The line in question.
3026 filename: The name of the current file.
3027 linenum: The number of the line to check.
3028 next_line_start: The first non-whitespace column of the next line.
3029 error: The function to call with any errors found.
3030 """
3033 # Check if the // may be in quotes. If so, ignore it
3035 # Allow one space for new scopes, two spaces otherwise:
3044 # Checks for common mistakes in TODO comments.
3048 # One whitespace is correct; zero whitespace is handled elsewhere.
3057 'Missing username in TODO; it should look like '
3061 # Comparisons made explicit for correctness -- pylint: disable=g-explicit-bool-comparison
3066 # If the comment contains an alphanumeric character, there
3067 # should be a space somewhere between it and the // unless
3068 # it's a /// or //! Doxygen comment.
3076 """Checks for the correctness of various spacing issues in the code.
3078 Things we check for: spaces around operators, spaces after
3079 if/for/while/switch, no spaces around parens in function calls, two
3080 spaces between code and comment, don't start a block with a blank
3081 line, don't end a function with a blank line, don't add a blank line
3082 after public/protected/private, don't have too many blank lines in a row.
3084 Args:
3085 filename: The name of the current file.
3086 clean_lines: A CleansedLines instance containing the file.
3087 linenum: The number of the line to check.
3088 nesting_state: A NestingState instance which maintains information about
3089 the current stack of nested blocks being parsed.
3090 error: The function to call with any errors found.
3091 """
3093 # Don't use "elided" lines here, otherwise we can't check commented lines.
3094 # Don't want to use "raw" either, because we don't want to check inside C++11
3095 # raw strings,
3099 # Before nixing comments, check if the line is blank for no good
3100 # reason. This includes the first line after a block is opened, and
3101 # blank lines at the end of a function (ie, right before a line like '}'
3102 #
3103 # Skip all the blank line checks if we are immediately inside a
3104 # namespace body. In other words, don't issue blank line warnings
3105 # for this block:
3106 # namespace {
3107 #
3108 # }
3109 #
3110 # A warning about missing end of namespace comments will be issued instead.
3111 #
3112 # Also skip blank line checks for 'extern "C"' blocks, which are formatted
3113 # like namespaces.
3120 # TODO(unknown): Don't complain if line before blank line, and line after,
3121 # both start with alnums and are indented the same amount.
3122 # This ignores whitespace at the start of a namespace block
3123 # because those are not usually indented.
3125 # OK, we have a blank line at the start of a code block. Before we
3126 # complain, we check if it is an exception to the rule: The previous
3127 # non-empty line has the parameters of a function header that are indented
3128 # 4 spaces (because they did not fit in a 80 column line when placed on
3129 # the same line as the function name). We also check for the case where
3130 # the previous line is indented 6 spaces, which may happen when the
3131 # initializers of a constructor do not fit into a 80 column line.
3134 # We are looking for the opening column of initializer list, which
3135 # should be indented 4 spaces to cause 6 space indentation afterwards.
3143 # Search for the function arguments or an initializer list. We use a
3144 # simple heuristic here: If the line is indented 4 spaces; and we have a
3145 # closing paren, without the opening paren, followed by an opening brace
3146 # or colon (for initializer lists) we assume that it is the last line of
3147 # a function header. If we have a colon indented 4 spaces, it is an
3148 # initializer list.
3150 prev_line)
3155 'Redundant blank line at the start of a code block '
3157 # Ignore blank lines at the end of a block in a long if-else
3158 # chain, like this:
3159 # if (condition1) {
3160 # // Something followed by a blank line
3161 #
3162 # } else if (condition2) {
3163 # // Something else
3164 # }
3171 'Redundant blank line at the end of a code block '
3179 # Next, check comments
3186 # get rid of comments and strings
3189 # You shouldn't have spaces before your brackets, except maybe after
3190 # 'delete []' or 'return []() {};'
3195 # In range-based for, we wanted spaces before and after the colon, but
3196 # not around "::" tokens that might appear.
3204 """Checks for horizontal spacing around operators.
3206 Args:
3207 filename: The name of the current file.
3208 clean_lines: A CleansedLines instance containing the file.
3209 linenum: The number of the line to check.
3210 error: The function to call with any errors found.
3211 """
3214 # Don't try to do spacing checks for operator methods. Do this by
3215 # replacing the troublesome characters with something else,
3216 # preserving column position for all other characters.
3217 #
3218 # The replacement is done repeatedly to avoid false positives from
3219 # operators that call operators.
3225 break
3227 # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )".
3228 # Otherwise not. Note we only check for non-spaces on *both* sides;
3229 # sometimes people put non-spaces on one side when aligning ='s among
3230 # many lines (not that this is behavior that I approve of...)
3234 # Operators taken from [lex.operators] in C++11 standard.
3240 # It's ok not to have spaces around binary operators like + - * /, but if
3241 # there's too little whitespace, we get concerned. It's hard to tell,
3242 # though, so we punt on this one for now. TODO.
3244 # You should always have whitespace around binary operators.
3245 #
3246 # Check <= and >= first to avoid false positives with < and >, then
3247 # check non-include lines for spacing around < and >.
3248 #
3249 # If the operator is followed by a comma, assume it's be used in a
3250 # macro context and don't do any checks. This avoids false
3251 # positives.
3252 #
3253 # Note that && is not included here. This is because there are too
3254 # many false positives due to RValue references.
3260 # Look for < that is not surrounded by spaces. This is only
3261 # triggered if both sides are missing spaces, even though
3262 # technically should should flag if at least one side is missing a
3263 # space. This is done to avoid some false positives with shifts.
3272 # Look for > that is not surrounded by spaces. Similar to the
3273 # above, we only trigger if both sides are missing spaces to avoid
3274 # false positives with shifts.
3283 # We allow no-spaces around << when used like this: 10<<20, but
3284 # not otherwise (particularly, not when used as streams)
3285 #
3286 # We also allow operators following an opening parenthesis, since
3287 # those tend to be macros that deal with operators.
3294 # We allow no-spaces around >> for almost anything. This is because
3295 # C++11 allows ">>" to close nested templates, which accounts for
3296 # most cases when ">>" is not followed by a space.
3297 #
3298 # We still warn on ">>" followed by alpha character, because that is
3299 # likely due to ">>" being used for right shifts, e.g.:
3300 # value >> alpha
3301 #
3302 # When ">>" is used to close templates, the alphanumeric letter that
3303 # follows would be part of an identifier, and there should still be
3304 # a space separating the template type and the identifier.
3305 # type<type<type>> alpha
3311 # There shouldn't be space around unary operators
3319 """Checks for horizontal spacing around parentheses.
3321 Args:
3322 filename: The name of the current file.
3323 clean_lines: A CleansedLines instance containing the file.
3324 linenum: The number of the line to check.
3325 error: The function to call with any errors found.
3326 """
3329 # No spaces after an if, while, switch, or for
3335 # For if/for/while/switch, the left and right parens should be
3336 # consistent about how many spaces are inside the parens, and
3337 # there should either be zero or one spaces inside the parens.
3338 # We don't want: "if ( foo)" or "if ( foo )".
3339 # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed.
3342 line)
3357 """Checks for horizontal spacing near commas and semicolons.
3359 Args:
3360 filename: The name of the current file.
3361 clean_lines: A CleansedLines instance containing the file.
3362 linenum: The number of the line to check.
3363 error: The function to call with any errors found.
3364 """
3368 # You should always have a space after a comma (either as fn arg or operator)
3369 #
3370 # This does not apply when the non-space character following the
3371 # comma is another comma, since the only time when that happens is
3372 # for empty macro arguments.
3373 #
3374 # We run this check in two passes: first pass on elided lines to
3375 # verify that lines contain missing whitespaces, second pass on raw
3376 # lines to confirm that those missing whitespaces are not due to
3377 # elided comments.
3383 # You should always have a space after a semicolon
3384 # except for few corner cases
3385 # TODO(unknown): clarify if 'if (1) { return 1;}' is requires one more
3386 # space after ;
3393 """Check if expression looks like a type name, returns true if so.
3395 Args:
3396 clean_lines: A CleansedLines instance containing the file.
3397 nesting_state: A NestingState instance which maintains information about
3398 the current stack of nested blocks being parsed.
3399 expr: The expression to check.
3400 Returns:
3401 True, if token looks like a type.
3402 """
3403 # Keep only the last token in the expression
3408 token = expr
3410 # Match native types and stdint types
3412 return True
3414 # Try a bit harder to match templated types. Walk up the nesting
3415 # stack until we find something that resembles a typename
3416 # declaration for what we are looking for.
3422 return False
3424 # Found where the opening brace is. We want to scan from this
3425 # line up to the beginning of the function, minus a few lines.
3426 # template <typename Type1, // stop scanning here
3427 # ...>
3428 # class C
3429 # : public ... { // start scanning here
3435 first_line = last_line
3438 break
3441 # Didn't find any "template" keyword before reaching the next block,
3442 # there are probably no template things to check for this block
3444 continue
3446 # Look for typename in the specified range
3449 return True
3452 return False
3456 """Checks for horizontal spacing near commas.
3458 Args:
3459 filename: The name of the current file.
3460 clean_lines: A CleansedLines instance containing the file.
3461 linenum: The number of the line to check.
3462 nesting_state: A NestingState instance which maintains information about
3463 the current stack of nested blocks being parsed.
3464 error: The function to call with any errors found.
3465 """
3468 # Except after an opening paren, or after another opening brace (in case of
3469 # an initializer list, for instance), you should have spaces before your
3470 # braces when they are delimiting blocks, classes, namespaces etc.
3471 # And since you should never have braces at the beginning of a line,
3472 # this is an easy test. Except that braces used for initialization don't
3473 # follow the same rule; we often don't want spaces before those.
3477 # Try a bit harder to check for brace initialization. This
3478 # happens in one of the following forms:
3479 # Constructor() : initializer_list_{} { ... }
3480 # Constructor{}.MemberFunction()
3481 # Type variable{};
3482 # FunctionCall(type{}, ...);
3483 # LastArgument(..., type{});
3484 # LOG(INFO) << type{} << " ...";
3485 # map_of_type[{...}] = ...;
3486 # ternary = expr ? new type{} : nullptr;
3487 # OuterTemplate<InnerTemplateConstructor<Type>{}>
3488 #
3489 # We check for the character following the closing brace, and
3490 # silence the warning if it's one of those listed above, i.e.
3491 # "{.;,)<>]:".
3492 #
3493 # To account for nested initializer list, we allow any number of
3494 # closing braces up to "{;,)<". We can't simply silence the
3495 # warning on first sight of closing brace, because that would
3496 # cause false negatives for things that are not initializer lists.
3497 # Silence this: But not this:
3498 # Outer{ if (...) {
3499 # Inner{...} if (...){ // Missing space before {
3500 # }; }
3501 #
3502 # There is a false negative with this approach if people inserted
3503 # spurious semicolons, e.g. "if (cond){};", but we will catch the
3504 # spurious semicolon with a separate check.
3514 # We also suppress warnings for `uint64_t{expression}` etc., as the style
3515 # guide recommends brace initialization for integral types to avoid
3516 # overflow/truncation.
3522 # Make sure '} else {' has spaces.
3527 # You shouldn't have a space before a semicolon at the end of the line.
3528 # There's a special case for "for" since the style guide allows space before
3529 # the semicolon there.
3535 'Line contains only semicolon. If this should be an empty statement, '
3540 'Extra space before last semicolon. If this should be an empty '
3545 """Check if the token ending on (linenum, column) is decltype().
3547 Args:
3548 clean_lines: A CleansedLines instance containing the file.
3549 linenum: the number of the line to check.
3550 column: end column of the token to check.
3551 Returns:
3552 True if this token is decltype() expression, False otherwise.
3553 """
3556 return False
3558 return True
3559 return False
3563 """Checks for additional blank line issues related to sections.
3565 Currently the only thing checked here is blank line before protected/private.
3567 Args:
3568 filename: The name of the current file.
3569 clean_lines: A CleansedLines instance containing the file.
3570 class_info: A _ClassInfo objects.
3571 linenum: The number of the line to check.
3572 error: The function to call with any errors found.
3573 """
3574 # Skip checks if the class is small, where small means 25 lines or less.
3575 # 25 lines seems like a good cutoff since that's the usual height of
3576 # terminals, and any class that can't fit in one screen can't really
3577 # be considered "small".
3578 #
3579 # Also skip checks if we are on the first line. This accounts for
3580 # classes that look like
3581 # class Foo { public: ... };
3582 #
3583 # If we didn't find the end of the class, last_line would be zero,
3584 # and the check will be skipped by the first condition.
3587 return
3591 # Issue warning if the line before public/protected/private was
3592 # not a blank line, but don't do this if the previous line contains
3593 # "class" or "struct". This can happen two ways:
3594 # - We are at the beginning of the class.
3595 # - We are forward-declaring an inner class that is semantically
3596 # private, but needed to be public for implementation reasons.
3597 # Also ignores cases where the previous line ends with a backslash as can be
3598 # common when defining classes in C macros.
3603 # Try a bit harder to find the beginning of the class. This is to
3604 # account for multi-line base-specifier lists, e.g.:
3605 # class Derived
3606 # : public Base {
3610 end_class_head = i
3611 break
3618 """Return the most recent non-blank line and its line number.
3620 Args:
3621 clean_lines: A CleansedLines instance containing the file contents.
3622 linenum: The number of the line to check.
3624 Returns:
3625 A tuple with two elements. The first element is the contents of the last
3626 non-blank line before the current line, or the empty string if this is the
3627 first non-blank line. The second is the line number of that line, or -1
3628 if this is the first non-blank line.
3629 """
3641 """Looks for misplaced braces (e.g. at the end of line).
3643 Args:
3644 filename: The name of the current file.
3645 clean_lines: A CleansedLines instance containing the file.
3646 linenum: The number of the line to check.
3647 error: The function to call with any errors found.
3648 """
3653 # We allow an open brace to start a line in the case where someone is using
3654 # braces in a block to explicitly create a new scope, which is commonly used
3655 # to control the lifetime of stack-allocated variables. Braces are also
3656 # used for brace initializers inside function calls. We don't detect this
3657 # perfectly: we just don't complain if the last non-whitespace character on
3658 # the previous non-blank line is ',', ';', ':', '(', '{', or '}', or if the
3659 # previous line starts a preprocessor block. We also allow a brace on the
3660 # following line if it is part of an array initialization and would not fit
3661 # within the 80 character limit of the preceding line.
3669 # An else clause should be on the same line as the preceding closing brace.
3676 # If braces come on one side of an else, they should be on both.
3677 # However, we have to worry about "else if" that spans multiple lines!
3680 # find the ( after the if
3693 # Likewise, an else should never have the else clause on the same line
3698 # In the same way, a do/while should never be on one line
3703 # Check single-line if/else bodies. The style guide says 'curly braces are not
3704 # required for single-line statements'. We additionally allow multi-line,
3705 # single statements, but we reject anything with more than one semicolon in
3706 # it. This means that the first semicolon after the if should be at the end of
3707 # its line, and the line after that should have an indent level equal to or
3708 # lower than the if. We also check for ambiguous if/else nesting without
3709 # braces.
3716 # This could be a multiline if condition, so find the end first.
3719 # Check for an opening brace, either directly after the if or on the next
3720 # line. If found, this isn't a single-statement conditional.
3731 # We allow a mix of whitespace and closing braces (e.g. for one-liner
3732 # methods) and a single \ after the semicolon (for macros)
3735 # Semicolon isn't the last character, there's something trailing.
3736 # Output a warning if the semicolon is not contained inside
3737 # a lambda expression.
3739 endline):
3743 # Make sure the next line is dedented
3746 # With ambiguous nested if statements, this will error out on the
3747 # if that *doesn't* match the else, regardless of whether it's the
3748 # inner one or outer one.
3752 'Else clause should be indented at the same level as if. '
3760 """Looks for redundant trailing semicolon.
3762 Args:
3763 filename: The name of the current file.
3764 clean_lines: A CleansedLines instance containing the file.
3765 linenum: The number of the line to check.
3766 error: The function to call with any errors found.
3767 """
3771 # Block bodies should not be followed by a semicolon. Due to C++11
3772 # brace initialization, there are more places where semicolons are
3773 # required than not, so we use a whitelist approach to check these
3774 # rather than a blacklist. These are the places where "};" should
3775 # be replaced by just "}":
3776 # 1. Some flavor of block following closing parenthesis:
3777 # for (;;) {};
3778 # while (...) {};
3779 # switch (...) {};
3780 # Function(...) {};
3781 # if (...) {};
3782 # if (...) else if (...) {};
3783 #
3784 # 2. else block:
3785 # if (...) else {};
3786 #
3787 # 3. const member function:
3788 # Function(...) const {};
3789 #
3790 # 4. Block following some statement:
3791 # x = 42;
3792 # {};
3793 #
3794 # 5. Block at the beginning of a function:
3795 # Function(...) {
3796 # {};
3797 # }
3798 #
3799 # Note that naively checking for the preceding "{" will also match
3800 # braces inside multi-dimensional arrays, but this is fine since
3801 # that expression will not contain semicolons.
3802 #
3803 # 6. Block following another block:
3804 # while (true) {}
3805 # {};
3806 #
3807 # 7. End of namespaces:
3808 # namespace {};
3809 #
3810 # These semicolons seems far more common than other kinds of
3811 # redundant semicolons, possibly due to people converting classes
3812 # to namespaces. For now we do not warn for this case.
3813 #
3814 # Try matching case 1 first.
3817 # Matched closing parenthesis (case 1). Check the token before the
3818 # matching opening parenthesis, and don't warn if it looks like a
3819 # macro. This avoids these false positives:
3820 # - macro that defines a base class
3821 # - multi-line macro that defines a base class
3822 # - macro that defines the whole class-head
3823 #
3824 # But we still issue warnings for macros that we know are safe to
3825 # warn, specifically:
3826 # - TEST, TEST_F, TEST_P, MATCHER, MATCHER_P
3827 # - TYPED_TEST
3828 # - INTERFACE_DEF
3829 # - EXCLUSIVE_LOCKS_REQUIRED, SHARED_LOCKS_REQUIRED, LOCKS_EXCLUDED:
3830 #
3831 # We implement a whitelist of safe macros instead of a blacklist of
3832 # unsafe macros, even though the latter appears less frequently in
3833 # google code and would have been easier to implement. This is because
3834 # the downside for getting the whitelist wrong means some extra
3835 # semicolons, while the downside for getting the blacklist wrong
3836 # would result in compile errors.
3837 #
3838 # In addition to macros, we also don't want to warn on
3839 # - Compound literals
3840 # - Lambdas
3841 # - alignas specifier with anonymous structs
3842 # - decltype
3863 # Multi-line lambda-expression
3867 # Try matching cases 2-3.
3870 # Try matching cases 4-6. These are always matched on separate lines.
3871 #
3872 # Note that we can't simply concatenate the previous line to the
3873 # current line and do a single match, otherwise we may output
3874 # duplicate warnings for the blank line case:
3875 # if (cond) {
3876 # // blank line
3877 # }
3882 # Check matching closing brace
3887 # Current {} pair is eligible for semicolon check, and we have found
3888 # the redundant semicolon, output warning here.
3889 #
3890 # Note: because we are scanning forward for opening braces, and
3891 # outputting warnings for the matching closing brace, if there are
3892 # nested blocks with trailing semicolons, we will get the error
3893 # messages in reversed order.
3895 # We need to check the line forward for NOLINT
3898 error)
3900 error)
3907 """Look for empty loop/conditional body with only a single semicolon.
3909 Args:
3910 filename: The name of the current file.
3911 clean_lines: A CleansedLines instance containing the file.
3912 linenum: The number of the line to check.
3913 error: The function to call with any errors found.
3914 """
3916 # Search for loop keywords at the beginning of the line. Because only
3917 # whitespaces are allowed before the keywords, this will also ignore most
3918 # do-while-loops, since those lines should start with closing brace.
3919 #
3920 # We also check "if" blocks here, since an empty conditional block
3921 # is likely an error.
3925 # Find the end of the conditional expression.
3929 # Output warning if what follows the condition expression is a semicolon.
3930 # No warning for all other cases, including whitespace or newline, since we
3931 # have a separate check for semicolons preceded by whitespace.
3940 # Check for if statements that have completely empty bodies (no comments)
3941 # and no else clauses.
3943 # Find the position of the opening { for the if statement.
3944 # Return without logging an error if it has no brackets.
3945 opening_linenum = end_linenum
3947 # Loop until EOF or find anything that's not whitespace or opening {.
3950 # Conditional has no brackets.
3951 return
3954 # Couldn't find conditional's opening { or any code before EOF.
3955 return
3957 # Set opening_line (opening_line_fragment may not be entire opening line).
3960 # Find the position of the closing }.
3963 # We need to make opening_pos relative to the start of the entire line.
3964 opening_pos += end_pos
3968 return
3970 # Now construct the body of the conditional. This consists of the portion
3971 # of the opening line after the {, all lines until the closing line,
3972 # and the portion of the closing line before the }.
3975 # Opening line ends with a comment, so conditional isn't empty.
3976 return
3978 # Opening line after the {. Ignore comments here since we checked above.
3980 # All lines until closing line, excluding closing line, with comments.
3982 # Closing line before the }. Won't (and can't) have comments.
3986 # If statement has brackets and fits on a single line.
3989 # Check if the body is empty
3991 return
3992 # The body is empty. Now make sure there's not an else clause.
3993 current_linenum = closing_linenum
3995 # Loop until EOF or find anything that's not whitespace or else clause.
3998 # Found an else clause, so don't log an error.
3999 return
4002 break
4005 # The body is empty and there's no else clause until EOF or other code.
4011 """Find a replaceable CHECK-like macro.
4013 Args:
4014 line: line to search on.
4015 Returns:
4016 (macro name, start position), or (None, -1) if no replaceable
4017 macro is found.
4018 """
4022 # Find opening parenthesis. Do a regular expression match here
4023 # to make sure that we are matching the expected CHECK macro, as
4024 # opposed to some other macro that happens to contain the CHECK
4025 # substring.
4028 continue
4034 """Checks the use of CHECK and EXPECT macros.
4036 Args:
4037 filename: The name of the current file.
4038 clean_lines: A CleansedLines instance containing the file.
4039 linenum: The number of the line to check.
4040 error: The function to call with any errors found.
4041 """
4043 # Decide the set of replacement macros that should be suggested
4047 return
4049 # Find end of the boolean expression by matching parentheses
4053 return
4055 # If the check macro is followed by something other than a
4056 # semicolon, assume users will log their own custom error messages
4057 # and don't suggest any replacements.
4059 return
4069 # Parse expression so that we can take parentheses into account.
4070 # This avoids false positives for inputs like "CHECK((a < 4) == b)",
4071 # which is not replaceable by CHECK_LE.
4081 # Parenthesized operand
4089 # Logical and/or operators. This means the expression
4090 # contains more than one term, for example:
4091 # CHECK(42 < a && a < b);
4092 #
4093 # These are not replaceable with CHECK_LE, so bail out early.
4094 return
4096 # Non-relational operator
4097 lhs += token
4100 # Relational operator
4101 operator = token
4103 break
4105 # Unparenthesized operand. Instead of appending to lhs one character
4106 # at a time, we do another regular expression match to consume several
4107 # characters at once if possible. Trivial benchmark shows that this
4108 # is more efficient when the operands are longer than a single
4109 # character, which is generally the case.
4114 break
4118 # Only apply checks if we got all parts of the boolean expression
4120 return
4122 # Check that rhs do not contain logical operators. We already know
4123 # that lhs is fine since the loop above parses out && and ||.
4125 return
4127 # At least one of the operands must be a constant literal. This is
4128 # to avoid suggesting replacements for unprintable things like
4129 # CHECK(variable != iterator)
4130 #
4131 # The following pattern matches decimal, hex integers, strings, and
4132 # characters (in that order).
4136 if Match(match_constant, lhs) or Match(match_constant, rhs):
4137 # Note: since we know both lhs and rhs, we can provide a more
4138 # descriptive error message like:
4139 # Consider using CHECK_EQ(x, 42) instead of CHECK(x == 42)
4140 # Instead of:
4141 # Consider using CHECK_EQ instead of CHECK(a == b)
4142 #
4143 # We are still keeping the less descriptive message because if lhs
4144 # or rhs gets long, the error message might become unreadable.
4147 _CHECK_REPLACEMENT[check_macro][operator],
4148 check_macro, operator))
4151 def CheckAltTokens(filename, clean_lines, linenum, error):
4152 """Check alternative keywords being used in boolean expressions.
4154 Args:
4155 filename: The name of the current file.
4156 clean_lines: A CleansedLines instance containing the file.
4157 linenum: The number of the line to check.
4158 error: The function to call with any errors found.
4159 """
4160 line = clean_lines.elided[linenum]
4162 # Avoid preprocessor lines
4164 return
4166 # Last ditch effort to avoid multi-line comments. This will not help
4167 # if the comment started before the current line or ended after the
4168 # current line, but it catches most of the false positives. At least,
4169 # it provides a way to workaround this warning for people who use
4170 # multi-line comments in preprocessor macros.
4171 #
4172 # TODO(unknown): remove this once cpplint has better support for
4173 # multi-line comments.
4175 return
4184 """Determines the width of the line in column positions.
4186 Args:
4187 line: A string, which may be a Unicode string.
4189 Returns:
4190 The width of the line in column positions, accounting for Unicode
4191 combining characters and wide characters.
4192 """
4200 return width
4206 error):
4207 """Checks rules from the 'C++ style rules' section of cppguide.html.
4209 Most of these rules are hard to test (naming, comment style), but we
4210 do what we can. In particular we check for 2-space indents, line lengths,
4211 tab usage, spaces inside code, etc.
4213 Args:
4214 filename: The name of the current file.
4215 clean_lines: A CleansedLines instance containing the file.
4216 linenum: The number of the line to check.
4217 file_extension: The extension (without the dot) of the filename.
4218 nesting_state: A NestingState instance which maintains information about
4219 the current stack of nested blocks being parsed.
4220 error: The function to call with any errors found.
4221 """
4223 # Don't use "elided" lines here, otherwise we can't check commented lines.
4224 # Don't want to use "raw" either, because we don't want to check inside C++11
4225 # raw strings,
4234 # One or three blank spaces at the beginning of the line is weird; it's
4235 # hard to reconcile that with 2-space indents.
4236 # NOTE: here are the conditions rob pike used for his tests. Mine aren't
4237 # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces
4238 # if(RLENGTH > 20) complain = 0;
4239 # if(match($0, " +(error|private|public|protected):")) complain = 0;
4240 # if(match(prev, "&& *$")) complain = 0;
4241 # if(match(prev, "\\|\\| *$")) complain = 0;
4242 # if(match(prev, "[\",=><] *$")) complain = 0;
4243 # if(match($0, " <<")) complain = 0;
4244 # if(match(prev, " +for \\(")) complain = 0;
4245 # if(prevodd && match(prevprev, " +for \\(")) complain = 0;
4252 # There are certain situations we allow one space, notably for
4253 # section labels, and also lines containing multi-line raw strings.
4254 # We also don't check for lines that look like continuation lines
4255 # (of lines ending in double quotes, commas, equals, or angle brackets)
4256 # because the rules for how to indent those are non-trivial.
4263 'Weird number of spaces at line-start. '
4270 # Check if the line is a header guard.
4278 # #include lines and header guards can be long, since there's no clean way to
4279 # split them.
4280 #
4281 # URLs can be long too. It's possible to split these, but it makes them
4282 # harder to cut&paste.
4283 #
4284 # The "$Id:...$" comment may also get very long without it being the
4285 # developers fault.
4296 # for loops are allowed two ;'s (and may run over two lines).
4300 # It's ok to have many commands in a switch case that fits in 1 line
4307 # Some more style checks
4325 # Matches the first component of a filename delimited by -s and _s. That is:
4326 # _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo'
4327 # _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo'
4328 # _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo'
4329 # _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo'
4334 """Drops common suffixes like _test.cc or -inl.h from filename.
4336 For example:
4337 >>> _DropCommonSuffixes('foo/foo-inl.h')
4338 'foo/foo'
4339 >>> _DropCommonSuffixes('foo/bar/foo.cc')
4340 'foo/bar/foo'
4341 >>> _DropCommonSuffixes('foo/foo_internal.h')
4342 'foo/foo'
4343 >>> _DropCommonSuffixes('foo/foo_unusualinternal.h')
4344 'foo/foo_unusualinternal'
4346 Args:
4347 filename: The input filename.
4349 Returns:
4350 The filename with the common suffix removed.
4351 """
4361 """Figures out what kind of header 'include' is.
4363 Args:
4364 fileinfo: The current file cpplint is running over. A FileInfo instance.
4365 include: The path to a #included file.
4366 is_system: True if the #include used <> rather than "".
4368 Returns:
4369 One of the _XXX_HEADER constants.
4371 For example:
4372 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True)
4373 _C_SYS_HEADER
4374 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True)
4375 _CPP_SYS_HEADER
4376 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False)
4377 _LIKELY_MY_HEADER
4378 >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'),
4379 ... 'bar/foo_other_ext.h', False)
4380 _POSSIBLE_MY_HEADER
4381 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False)
4382 _OTHER_HEADER
4383 """
4384 # This is a list of all standard c++ header files, except
4385 # those already checked for above.
4390 return _CPP_SYS_HEADER
4392 return _C_SYS_HEADER
4394 # If the target file and the include we're checking share a
4395 # basename when we drop common extensions, and the include
4396 # lives in . , then it's likely to be owned by the target file.
4403 return _LIKELY_MY_HEADER
4405 # If the target and include share some initial basename
4406 # component, it's possible the target is implementing the
4407 # include, so it's allowed to be first, but we'll never
4408 # complain if it's not there.
4414 return _POSSIBLE_MY_HEADER
4416 return _OTHER_HEADER
4421 """Check rules that are applicable to #include lines.
4423 Strings on #include lines are NOT removed from elided line, to make
4424 certain tasks easier. However, to prevent false positives, checks
4425 applicable to #include lines in CheckLanguage must be put here.
4427 Args:
4428 filename: The name of the current file.
4429 clean_lines: A CleansedLines instance containing the file.
4430 linenum: The number of the line to check.
4431 include_state: An _IncludeState instance in which the headers are inserted.
4432 error: The function to call with any errors found.
4433 """
4437 # "include" should use the new style "foo/bar.h" instead of just "bar.h"
4438 # Only do this check if the included header follows google naming
4439 # conventions. If not, assume that it's a 3rd party API that
4440 # requires special include conventions.
4441 #
4442 # We also make an exception for Lua headers, which follow google
4443 # naming convention but not the include convention.
4449 # we shouldn't include a file more than once. actually, there are a
4450 # handful of instances where doing so is okay, but in general it's
4451 # not.
4468 # We want to ensure that headers appear in the right order:
4469 # 1) for foo.cc, foo.h (preferred location)
4470 # 2) c system files
4471 # 3) cpp system files
4472 # 4) for foo.cc, foo.h (deprecated location)
4473 # 5) other google headers
4474 #
4475 # We classify each include statement as one of those 5 types
4476 # using a number of techniques. The include_state object keeps
4477 # track of the highest type seen, and complains if we see a
4478 # lower type after that.
4495 r"""Retrieves all the text between matching open and close parentheses.
4497 Given a string of lines and a regular expression string, retrieve all the text
4498 following the expression and between opening punctuation symbols like
4499 (, [, or {, and the matching close-punctuation symbol. This properly nested
4500 occurrences of the punctuations, so for the text like
4501 printf(a(), b(c()));
4502 a call to _GetTextInside(text, r'printf\(') will return 'a(), b(c())'.
4503 start_pattern must match string having an open punctuation symbol at the end.
4505 Args:
4506 text: The lines to extract text. Its comments and strings must be elided.
4507 It can be single line and can span multiple lines.
4508 start_pattern: The regexp string indicating where to start extracting
4509 the text.
4510 Returns:
4511 The extracted text.
4512 None if either the opening string or ending punctuation could not be found.
4513 """
4514 # TODO(unknown): Audit cpplint.py to see what places could be profitably
4515 # rewritten to use _GetTextInside (and use inferior regexp matching today).
4517 # Give opening punctuations to get the matching close-punctuations.
4521 # Find the position to start extracting text.
4524 return None
4531 # Stack of closing punctuations we expect to have in text after position.
4533 position = start_position
4538 # A closing punctuation without matching opening punctuations.
4539 return None
4544 # Opening punctuations left without matching close-punctuations.
4545 return None
4546 # punctuations match.
4550 # Patterns for matching call-by-reference parameters.
4551 #
4552 # Supports nested templates up to 2 levels deep using this messy pattern:
4553 # < (?: < (?: < [^<>]*
4554 # >
4555 # | [^<>] )*
4556 # >
4557 # | [^<>] )*
4558 # >
4560 _RE_PATTERN_TYPE = (
4561 r'(?:const\s+)?(?:typename\s+|class\s+|struct\s+|union\s+|enum\s+)?'
4562 r'(?:\w|'
4563 r'\s*<(?:<(?:<[^<>]*>|[^<>])*>|[^<>])*>|'
4565 # A call-by-reference parameter ends with '& identifier'.
4569 # A call-by-const-reference parameter either ends with 'const& identifier'
4570 # or looks like 'const type& identifier' when 'type' is atomic.
4571 _RE_PATTERN_CONST_REF_PARAM = (
4574 # Stream types.
4575 _RE_PATTERN_REF_STREAM_PARAM = (
4581 """Checks rules from the 'C++ language rules' section of cppguide.html.
4583 Some of these rules are hard to test (function overloading, using
4584 uint32 inappropriately), but we do the best we can.
4586 Args:
4587 filename: The name of the current file.
4588 clean_lines: A CleansedLines instance containing the file.
4589 linenum: The number of the line to check.
4590 file_extension: The extension (without the dot) of the filename.
4591 include_state: An _IncludeState instance in which the headers are inserted.
4592 nesting_state: A NestingState instance which maintains information about
4593 the current stack of nested blocks being parsed.
4594 error: The function to call with any errors found.
4595 """
4596 # If the line is empty or consists of entirely a comment, no need to
4597 # check it.
4600 return
4605 return
4607 # Reset include state across preprocessor directives. This is meant
4608 # to silence warnings for conditional includes.
4613 # Make Windows paths like Unix.
4616 # Perform other checks now that we are sure that this is not an include line
4622 # TODO(unknown): check that 1-arg constructors are explicit.
4623 # How to tell it's a constructor?
4624 # (handled in CheckForNonStandardConstructs for now)
4625 # TODO(unknown): check that classes declare or disable copy/assign
4626 # (level 1 error)
4627 pass
4629 # Check if people are using the verboten C basic types. The only exception
4630 # we regularly allow is "unsigned short port" for port.
4641 # Check if some verboten operator overloading is going on
4642 # TODO(unknown): catch out-of-line unary operator&:
4643 # class X {};
4644 # int operator&(const X& x) { return 42; } // unary operator&
4645 # The trick is it's hard to tell apart from binary operator&:
4646 # class Y { int operator&(const Y& x) { return 23; } }; // binary operator&
4651 # Check for suspicious usage of "if" like
4652 # } if (a == b) {
4657 # Check for potential format string bugs like printf(foo).
4658 # We constrain the pattern not to pick things like DocidForPrintf(foo).
4659 # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str())
4660 # TODO(unknown): Catch the following case. Need to change the calling
4661 # convention of the whole function to process multiple line to handle it.
4662 # printf(
4663 # boy_this_is_a_really_long_variable_that_cannot_fit_on_the_prev_line);
4674 # Check for potential memset bugs like memset(buf, sizeof(buf), 0).
4683 'Do not use namespace using-directives. '
4686 # Detect variable-length arrays.
4690 # Split the size using space and arithmetic operators as delimiters.
4691 # If any of the resulting tokens are not compile time constants then
4692 # report the error.
4699 continue
4712 # A catch all for tricky sizeof cases, including 'sizeof expression',
4713 # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)'
4714 # requires skipping the next token because we split on ' ' and '*'.
4717 continue
4719 break
4722 'Do not use variable-length arrays. Use an appropriately named '
4725 # Check for use of unnamed namespaces in header files. Registration
4726 # macros are typically OK, so we allow use of "namespace {" on lines
4727 # that end with backslashes.
4732 'Do not use unnamed namespaces in header files. See '
4733 'https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces'
4738 """Check for unsafe global or static objects.
4740 Args:
4741 filename: The name of the current file.
4742 clean_lines: A CleansedLines instance containing the file.
4743 linenum: The number of the line to check.
4744 error: The function to call with any errors found.
4745 """
4748 # Match two lines at a time to support multiline declarations
4752 # Check for people declaring static/global STL strings at the top level.
4753 # This is dangerous because the C++ language does not guarantee that
4754 # globals with constructors are initialized before the first access, and
4755 # also because globals can be destroyed when some threads are still running.
4756 # TODO(unknown): Generalize this to also find static unique_ptr instances.
4757 # TODO(unknown): File bugs for clang-tidy to find these.
4759 r'((?:|static +)(?:|const +))(?::*std::)?string( +const)? +'
4761 line)
4763 # Remove false positives:
4764 # - String pointers (as opposed to values).
4765 # string *pointer
4766 # const string *pointer
4767 # string const *pointer
4768 # string *const pointer
4769 #
4770 # - Functions and template specializations.
4771 # string Function<Type>(...
4772 # string Class<Type>::Method(...
4773 #
4774 # - Operators. These are matched separately because operator names
4775 # cross non-word boundaries, and trying to match both operators
4776 # and functions at the same time would decrease accuracy of
4777 # matching identifiers.
4778 # string Class::operator*()
4785 'For a static/global string constant, use a C style string '
4799 """Check for printf related issues.
4801 Args:
4802 filename: The name of the current file.
4803 clean_lines: A CleansedLines instance containing the file.
4804 linenum: The number of the line to check.
4805 error: The function to call with any errors found.
4806 """
4809 # When snprintf is used, the second argument shouldn't be a literal.
4812 # If 2nd arg is zero, snprintf is used to calculate size.
4817 # Check if some verboten C functions are being used.
4828 """Check if current line contains an inherited function.
4830 Args:
4831 clean_lines: A CleansedLines instance containing the file.
4832 linenum: The number of the line to check.
4833 Returns:
4834 True if current line contains a function with "override"
4835 virt-specifier.
4836 """
4837 # Scan back a few lines for start of current function
4841 # Look for "override" after the matching closing parenthesis
4846 return False
4850 """Check if current line contains an out-of-line method definition.
4852 Args:
4853 clean_lines: A CleansedLines instance containing the file.
4854 linenum: The number of the line to check.
4855 Returns:
4856 True if current line contains an out-of-line method definition.
4857 """
4858 # Scan back a few lines for start of current function
4862 return False
4866 """Check if current line is inside constructor initializer list.
4868 Args:
4869 clean_lines: A CleansedLines instance containing the file.
4870 linenum: The number of the line to check.
4871 Returns:
4872 True if current line appears to be inside constructor initializer
4873 list, False otherwise.
4874 """
4883 # A lone colon tend to indicate the start of a constructor
4884 # initializer list. It could also be a ternary operator, which
4885 # also tend to appear in constructor initializer lists as
4886 # opposed to parameter lists.
4887 return True
4889 # A closing brace followed by a comma is probably the end of a
4890 # brace-initialized member in constructor initializer list.
4891 return True
4893 # Found one of the following:
4894 # - A closing brace or semicolon, probably the end of the previous
4895 # function.
4896 # - An opening brace, probably the start of current class or namespace.
4897 #
4898 # Current line is probably not inside an initializer list since
4899 # we saw one of those things without seeing the starting colon.
4900 return False
4902 # Got to the beginning of the file without seeing the start of
4903 # constructor initializer list.
4904 return False
4909 """Check for non-const references.
4911 Separate from CheckLanguage since it scans backwards from current
4912 line, instead of scanning forward.
4914 Args:
4915 filename: The name of the current file.
4916 clean_lines: A CleansedLines instance containing the file.
4917 linenum: The number of the line to check.
4918 nesting_state: A NestingState instance which maintains information about
4919 the current stack of nested blocks being parsed.
4920 error: The function to call with any errors found.
4921 """
4922 # Do nothing if there is no '&' on current line.
4925 return
4927 # If a function is inherited, current function doesn't have much of
4928 # a choice, so any non-const references should not be blamed on
4929 # derived function.
4931 return
4933 # Don't warn on out-of-line method definitions, as we would warn on the
4934 # in-line declaration, if it isn't marked with 'override'.
4936 return
4938 # Long type names may be broken across multiple lines, usually in one
4939 # of these forms:
4940 # LongType
4941 # ::LongTypeContinued &identifier
4942 # LongType::
4943 # LongTypeContinued &identifier
4944 # LongType<
4945 # ...>::LongTypeContinued &identifier
4946 #
4947 # If we detected a type split across two lines, join the previous
4948 # line to current line so that we can match const references
4949 # accordingly.
4950 #
4951 # Note that this only scans back one line, since scanning back
4952 # arbitrary number of lines would be expensive. If you have a type
4953 # that spans more than 2 lines, please use a typedef.
4957 # previous_line\n + ::current_line
4961 # previous_line::\n + current_line
4967 # Check for templated parameter that is split across multiple lines
4973 # Found the matching < on an earlier line, collect all
4974 # pieces up to current line.
4979 # Check for non-const references in function parameters. A single '&' may
4980 # found in the following places:
4981 # inside expression: binary & for bitwise AND
4982 # inside expression: unary & for taking the address of something
4983 # inside declarators: reference parameter
4984 # We will exclude the first two cases by checking that we are not inside a
4985 # function body, including one that was just introduced by a trailing '{'.
4986 # TODO(unknown): Doesn't account for 'catch(Exception& e)' [rare].
4990 # Not at toplevel, not within a class, and not within a namespace
4991 return
4993 # Avoid initializer lists. We only need to scan back from the
4994 # current line for something that starts with ':'.
4995 #
4996 # We don't need to check the current line, since the '&' would
4997 # appear inside the second set of parentheses on the current line as
4998 # opposed to the first set.
5003 break
5005 return
5007 # Avoid preprocessors
5009 return
5011 # Avoid constructor initializer lists
5013 return
5015 # We allow non-const references in a few standard places, like functions
5016 # called "swap()" or iostream operators like "<<" or ">>". Do not check
5017 # those function parameters.
5018 #
5019 # We also accept & in static_assert, which looks like a function but
5020 # it's actually a declaration expression.
5022 r'operator\s*[<>][<>]|'
5023 r'static_assert|COMPILE_ASSERT'
5026 return
5028 # Don't see a whitelisted function on this line. Actually we
5029 # didn't see any function name on this line, so this is likely a
5030 # multi-line parameter list. Try a bit harder to catch this case.
5034 return
5041 'Is this a non-const reference? '
5047 """Various cast related checks.
5049 Args:
5050 filename: The name of the current file.
5051 clean_lines: A CleansedLines instance containing the file.
5052 linenum: The number of the line to check.
5053 error: The function to call with any errors found.
5054 """
5057 # Check to see if they're using an conversion function cast.
5058 # I just try to capture the most common basic types, though there are more.
5059 # Parameterless conversion functions, such as bool(), are allowed as they are
5060 # probably a member operator declaration or default constructor.
5062 r'(\bnew\s+(?:const\s+)?|\S<\s*(?:const\s+)?)?\b'
5063 r'(int|float|double|bool|char|int32|uint32|int64|uint64)'
5069 # matched_new_or_template is used to silence two false positives:
5070 # - New operators
5071 # - Template arguments with function types
5072 #
5073 # For template arguments, we match on types immediately following
5074 # an opening bracket without any spaces. This is a fast way to
5075 # silence the common case where the function type is the first
5076 # template argument. False negative with less-than comparison is
5077 # avoided because those operators are usually followed by a space.
5078 #
5079 # function<double(double)> // bracket + no space = false positive
5080 # value < double(42) // bracket + space = true positive
5083 # Avoid arrays by looking for brackets that come after the closing
5084 # parenthesis.
5086 return
5088 # Other things to ignore:
5089 # - Function pointers
5090 # - Casts to pointer types
5091 # - Placement new
5092 # - Alias declarations
5102 'Using deprecated casting style. '
5104 matched_type)
5110 # This doesn't catch all cases. Consider (const char * const)"hello".
5111 #
5112 # (char *) "foo" should always be a const_cast (reinterpret_cast won't
5113 # compile).
5116 pass
5118 # Check pointer casts for other than string constants
5122 # In addition, we look for people taking the address of a cast. This
5123 # is dangerous -- casts can assign to temporaries, so the pointer doesn't
5124 # point where you think.
5125 #
5126 # Some non-identifier character is required before the '&' for the
5127 # expression to be recognized as a cast. These are casts:
5128 # expression = &static_cast<int*>(temporary());
5129 # function(&(int*)(temporary()));
5130 #
5131 # This is not a cast:
5132 # reference_type&(int* function_param);
5134 r'(?:[^\w]&\(([^)*][^)]*)\)[\w(])|'
5137 # Try a better error message when the & is bound to something
5138 # dereferenced by the casted pointer, as opposed to the casted
5139 # pointer itself.
5156 'from a cast? Wrapping the dereferenced expression in '
5161 'This is dangerous: could be a temp var. '
5166 """Checks for a C-style cast by looking for the pattern.
5168 Args:
5169 filename: The name of the current file.
5170 clean_lines: A CleansedLines instance containing the file.
5171 linenum: The number of the line to check.
5172 cast_type: The string for the C++ cast to recommend. This is either
5173 reinterpret_cast, static_cast, or const_cast, depending.
5174 pattern: The regular expression used to find C-style casts.
5175 error: The function to call with any errors found.
5177 Returns:
5178 True if an error was emitted.
5179 False otherwise.
5180 """
5184 return False
5186 # Exclude lines with keywords that tend to look like casts
5189 return False
5191 # Try expanding current context to see if we one level of
5192 # parentheses inside a macro.
5197 return False
5199 # operator++(int) and operator--(int)
5201 return False
5203 # A single unnamed argument for a function tends to look like old style cast.
5204 # If we see those, don't issue warnings for deprecated casts.
5207 remainder):
5208 return False
5210 # At this point, all that should be left is actual casts.
5215 return True
5219 """Checks whether where function type arguments are expected.
5221 Args:
5222 clean_lines: A CleansedLines instance containing the file.
5223 linenum: The number of the line to check.
5225 Returns:
5226 True if the line at 'linenum' is inside something that expects arguments
5227 of function types.
5228 """
5240 _HEADERS_CONTAINING_TEMPLATES = (
5258 )),
5274 # gcc extensions.
5275 # Note: std::hash is their hash, ::hash is our hash
5279 )
5281 _HEADERS_MAYBE_TEMPLATES = (
5284 )),
5286 )
5290 _re_pattern_headers_maybe_templates = []
5293 # Match max<type>(..., ...), max(..., ...), but not foo->max, foo.max or
5294 # type::max().
5297 _template,
5298 _header))
5300 # Other scripts may reach in and modify this pattern.
5301 _re_pattern_templates = []
5307 _header))
5311 """Check if these two filenames belong to the same module.
5313 The concept of a 'module' here is a as follows:
5314 foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the
5315 same 'module' if they are in the same directory.
5316 some/path/public/xyzzy and some/path/internal/xyzzy are also considered
5317 to belong to the same module here.
5319 If the filename_cc contains a longer path than the filename_h, for example,
5320 '/absolute/path/to/base/sysinfo.cc', and this file would include
5321 'base/sysinfo.h', this function also produces the prefix needed to open the
5322 header. This is used by the caller of this function to more robustly open the
5323 header file. We don't have access to the real include paths in this context,
5324 so we need this guesswork here.
5326 Known bugs: tools/base/bar.cc and base/bar.h belong to the same module
5327 according to this implementation. Because of this, this function gives
5328 some false positives. This should be sufficiently rare in practice.
5330 Args:
5331 filename_cc: is the path for the .cc file
5332 filename_h: is the path for the header path
5334 Returns:
5335 Tuple with a bool and a string:
5336 bool: True if filename_cc and filename_h belong to the same module.
5337 string: the additional prefix needed to open the header file.
5338 """
5366 """Fill up the include_dict with new includes found from the file.
5368 Args:
5369 filename: the name of the header to read.
5370 include_dict: a dictionary in which the headers are inserted.
5371 io: The io factory to use to read the file. Provided for testability.
5373 Returns:
5374 True if a header was successfully added. False otherwise.
5375 """
5380 return False
5389 return True
5394 """Reports for missing stl includes.
5396 This function will output warnings to make sure you are including the headers
5397 necessary for the stl containers and functions that you use. We only give one
5398 reason to include a header. For example, if you use both equal_to<> and
5399 less<> in a .h file, only one (the latter in the file) of these will be
5400 reported as a reason to include the <functional>.
5402 Args:
5403 filename: The name of the current file.
5404 clean_lines: A CleansedLines instance containing the file.
5405 include_state: An _IncludeState instance.
5406 error: The function to call with any errors found.
5407 io: The IO factory to use to read the header file. Provided for unittest
5408 injection.
5409 """
5411 # Example of required: { '<functional>': (1219, 'less<>') }
5416 continue
5418 # String is special -- it is a non-templatized type in STL.
5421 # Don't warn about strings in non-STL namespaces:
5422 # (We check only the first match per line; good enough.)
5431 # The following function is just a speed up, no semantics are changed.
5433 continue
5438 # Don't warn about IWYU in non-STL namespaces:
5439 # (We check only the first match per line; good enough.)
5444 # The policy is that if you #include something in foo.h you don't need to
5445 # include it again in foo.cc. Here, we will look at possible includes.
5446 # Let's flatten the include_state include_list and copy it into a dictionary.
5450 # Did we find the header for this file (if any) and successfully load it?
5453 # Use the absolute path so that matching works properly.
5456 # For Emacs's flymake.
5457 # If cpplint is invoked from Emacs's flymake, a temporary file is generated
5458 # by flymake and that file name might end with '_flymake.cc'. In that case,
5459 # restore original file name here so that the corresponding header file can be
5460 # found.
5461 # e.g. If the file name is 'foo_flymake.cc', we should search for 'foo.h'
5462 # instead of 'foo_flymake.h'
5465 # include_dict is modified during iteration, so we iterate over a copy of
5466 # the keys.
5474 # If we can't find the header file for a .cc, assume it's because we don't
5475 # know where to look. In that case we'll give up as we're not sure they
5476 # didn't include it in the .h file.
5477 # TODO(unknown): Do a better job of finding .h files so we are confident that
5478 # not having the .h file means there isn't one.
5480 return
5482 # All the lines have been processed, report the errors found.
5495 """Check that make_pair's template arguments are deduced.
5497 G++ 4.6 in C++11 mode fails badly if make_pair's template arguments are
5498 specified explicitly, and such use isn't intended in any case.
5500 Args:
5501 filename: The name of the current file.
5502 clean_lines: A CleansedLines instance containing the file.
5503 linenum: The number of the line to check.
5504 error: The function to call with any errors found.
5505 """
5511 'For C++11-compatibility, omit template arguments from make_pair'
5516 """Check if line contains a redundant "virtual" function-specifier.
5518 Args:
5519 filename: The name of the current file.
5520 clean_lines: A CleansedLines instance containing the file.
5521 linenum: The number of the line to check.
5522 error: The function to call with any errors found.
5523 """
5524 # Look for "virtual" on current line.
5529 # Ignore "virtual" keywords that are near access-specifiers. These
5530 # are only used in class base-specifier and do not apply to member
5531 # functions.
5534 return
5536 # Ignore the "virtual" keyword from virtual base classes. Usually
5537 # there is a column on the same line in these cases (virtual base
5538 # classes are rare in google3 because multiple inheritance is rare).
5541 # Look for the next opening parenthesis. This is the start of the
5542 # parameter list (possibly on the next line shortly after virtual).
5543 # TODO(unknown): doesn't work if there are virtual functions with
5544 # decltype() or other things that use parentheses, but csearch suggests
5545 # that this is rare.
5553 # Match parentheses to find the end of the parameter list
5556 break
5562 # Look for "override" or "final" after the parameter list
5563 # (possibly on the next few lines).
5572 # Set end_col to check whole lines after we are done with the
5573 # first line.
5576 break
5580 """Check if line contains a redundant "override" or "final" virt-specifier.
5582 Args:
5583 filename: The name of the current file.
5584 clean_lines: A CleansedLines instance containing the file.
5585 linenum: The number of the line to check.
5586 error: The function to call with any errors found.
5587 """
5588 # Look for closing parenthesis nearby. We need one to confirm where
5589 # the declarator ends and where the virt-specifier starts to avoid
5590 # false positives.
5597 fragment = line
5599 return
5601 # Check that at most one of "override" or "final" is present, not both
5610 # Returns true if we are at a new block, and it is directly
5611 # inside of a namespace.
5613 """Checks that the new block is directly in a namespace.
5615 Args:
5616 nesting_state: The _NestingState object that contains info about our state.
5617 is_forward_declaration: If the class is a forward declared class.
5618 Returns:
5619 Whether or not the new block is directly in a namespace.
5620 """
5624 return True
5626 return False
5635 """This method determines if we should apply our namespace indentation check.
5637 Args:
5638 nesting_state: The current nesting state.
5639 is_namespace_indent_item: If we just put a new class on the stack, True.
5640 If the top of the stack is not a class, or we did not recently
5641 add the class, False.
5642 raw_lines_no_comments: The lines without the comments.
5643 linenum: The current line number we are processing.
5645 Returns:
5646 True if we should apply our namespace indentation check. Currently, it
5647 only works for classes and namespaces inside of a namespace.
5648 """
5651 linenum)
5654 return False
5656 # If we are in a macro, we do not want to check the namespace indentation.
5658 return False
5663 # Call this method if the line is directly inside of a namespace.
5664 # If the line above is blank (excluding comments) or the start of
5665 # an inner namespace, it cannot be indented.
5667 error):
5676 extra_check_functions=[]):
5677 """Processes a single line in the file.
5679 Args:
5680 filename: Filename of the file that is being processed.
5681 file_extension: The extension (dot not included) of the file.
5682 clean_lines: An array of strings, each representing a line of the file,
5683 with comments stripped.
5684 line: Number of line being processed.
5685 include_state: An _IncludeState instance in which the headers are inserted.
5686 function_state: A _FunctionState instance which counts function lines, etc.
5687 nesting_state: A NestingState instance which maintains information about
5688 the current stack of nested blocks being parsed.
5689 error: A callable to which errors are reported, which takes 4 arguments:
5690 filename, line number, error level, and message
5691 extra_check_functions: An array of additional check functions that will be
5692 run on each source line. Each function takes 4
5693 arguments: filename, clean_lines, line, error
5694 """
5699 error)
5719 """Flag those c++11 features that we only allow in certain places.
5721 Args:
5722 filename: The name of the current file.
5723 clean_lines: A CleansedLines instance containing the file.
5724 linenum: The number of the line to check.
5725 error: The function to call with any errors found.
5726 """
5731 # Flag unapproved C++ TR1 headers.
5736 # Flag unapproved C++11 headers.
5747 ):
5751 # The only place where we need to worry about C++11 keywords and library
5752 # features in preprocessor directives is in macro definitions.
5755 # These are classes and free functions. The classes are always
5756 # mentioned as std::*, but we only catch the free functions if
5757 # they're not found by ADL. They're alphabetical by header.
5759 # type_traits
5762 ):
5766 'an example of where it would make your code more readable, and '
5771 """Flag those C++14 features that we restrict.
5773 Args:
5774 filename: The name of the current file.
5775 clean_lines: A CleansedLines instance containing the file.
5776 linenum: The number of the line to check.
5777 error: The function to call with any errors found.
5778 """
5783 # Flag unapproved C++14 headers.
5790 extra_check_functions=[]):
5791 """Performs lint checks and reports any errors to the given error function.
5793 Args:
5794 filename: Filename of the file that is being processed.
5795 file_extension: The extension (dot not included) of the file.
5796 lines: An array of strings, each representing a line of the file, with the
5797 last element being empty if the file is terminated with a newline.
5798 error: A callable to which errors are reported, which takes 4 arguments:
5799 filename, line number, error level, and message
5800 extra_check_functions: An array of additional check functions that will be
5801 run on each source line. Each function takes 4
5802 arguments: filename, clean_lines, line, error
5803 """
5824 extra_check_functions)
5830 # Check that the .cc file has included its header if it exists.
5834 # We check here rather than inside ProcessLine so that we see raw
5835 # lines rather than "cleaned" lines.
5841 """ Loads the configuration files and processes the config overrides.
5843 Args:
5844 filename: The name of the file being processed by the linter.
5846 Returns:
5847 False if the current |filename| should not be processed further.
5848 """
5851 cfg_filters = []
5859 abs_filename = abs_path
5861 continue
5868 continue
5878 # When matching exclude_files pattern, use the base_name of
5879 # the current file name or the directory name we are processing.
5880 # For example, if we are checking for lint errors in /foo/bar/baz.cc
5881 # and we found the .cfg file at /foo/CPPLINT.cfg, then the config
5882 # file's "exclude_files" filter is meant to be checked against "bar"
5883 # and not "baz" nor "bar/baz.cc".
5891 return False
5893 global _line_length
5899 global _root
5900 _root = val
5913 # Apply all the accumulated filters in reverse order (top-level directory
5914 # config options having the least priority).
5918 return True
5922 """Does google-lint on a single file.
5924 Args:
5925 filename: The name of the file to parse.
5927 vlevel: The level of errors to report. Every error of confidence
5928 >= verbose_level will be reported. 0 is a good default.
5930 extra_check_functions: An array of additional check functions that will be
5931 run on each source line. Each function takes 4
5932 arguments: filename, clean_lines, line, error
5933 """
5940 return
5942 lf_lines = []
5943 crlf_lines = []
5945 # Support the UNIX convention of using "-" for stdin. Note that
5946 # we are not opening the file with universal newline support
5947 # (which codecs doesn't support anyway), so the resulting lines do
5948 # contain trailing '\r' characters if we are reading a file that
5949 # has CRLF endings.
5950 # If after the split a trailing '\r' is present, it is removed
5951 # below.
5960 # Remove trailing '\r'.
5961 # The -1 accounts for the extra trailing blank line we get from split()
5973 return
5975 # Note, if no dot is found, this will give the entire filename as the ext.
5978 # When reading from stdin, the extension is unknown, so no cpplint tests
5979 # should rely on the extension.
5985 extra_check_functions)
5987 # If end-of-line sequences are a mix of LF and CR-LF, issue
5988 # warnings on the lines with CR.
5989 #
5990 # Don't issue any warnings if all lines are uniformly LF or CR-LF,
5991 # since critique can handle these just fine, and the style guide
5992 # doesn't dictate a particular end of line sequence.
5993 #
5994 # We can't depend on os.linesep to determine what the desired
5995 # end-of-line sequence should be, since that will return the
5996 # server-side end-of-line sequence.
5998 # Warn on every line with CR. An alternative approach might be to
5999 # check whether the file is mostly CRLF or just LF, and warn on the
6000 # minority, we bias toward LF here since most tools prefer LF.
6010 """Prints a brief usage string and exits, optionally with an error message.
6012 Args:
6013 message: The optional error message.
6014 """
6023 """Prints a list of all the error-categories used by error messages.
6025 These are the categories used to filter messages via --filter.
6026 """
6032 """Parses the command line arguments.
6034 This may set the output format and verbosity level as side-effects.
6036 Args:
6037 args: The command line arguments:
6039 Returns:
6040 The list of filenames to lint.
6041 """
6064 output_format = val
6068 filters = val
6074 counting_style = val
6076 global _root
6077 _root = val
6079 global _line_length
6085 global _valid_extensions
6101 return filenames
6107 # Change stderr to write with replacement characters so we don't die
6108 # if we try to print something containing non-ASCII characters.