| blob | 25fbef73d8edac6526704db76dacd5b7f70b65df |
1 #!/usr/bin/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]
60 <file> [file] ...
62 The style guidelines this tries to follow are those in
63 http://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 Assuing 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
136 """
138 # We categorize each error message we print. Here are the categories.
139 # We want an explicit list so we can list them all in cpplint --filter=.
140 # If you add a new error message with a new category, add it to the list
141 # here! cpplint_unittest.py should tell you if you forget to do this.
142 _ERROR_CATEGORIES = [
204 'whitespace/todo'
205 ]
207 # The default state of the category filter. This is overrided by the --filter=
208 # flag. By default all errors are on, so only add here categories that should be
209 # off by default (i.e., categories that must be enabled by the --filter= flags).
210 # All entries here should start with a '-' or '+', as in the --filter= flag.
213 # We used to check for high-bit characters, but after much discussion we
214 # decided those were OK, as long as they were in UTF-8 and didn't represent
215 # hard-coded international strings, which belong in a separate i18n file.
218 # C++ headers
220 # Legacy
272 # 17.6.1.2 C++ library headers
325 # 17.6.1.2 C++ headers for C library facilities
352 ])
354 # Assertion macros. These are defined in base/logging.h and
355 # testing/base/gunit.h. Note that the _M versions need to come first
356 # for substring matching to work.
357 _CHECK_MACROS = [
363 ]
365 # Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE
386 # Alternative tokens and their replacements. For full list, see section 2.5
387 # Alternative tokens [lex.digraph] in the C++ standard.
388 #
389 # Digraphs (such as '%:') are not included here since it's a mess to
390 # match those on a word boundary.
391 _ALT_TOKEN_REPLACEMENT = {
403 }
405 # Compile regular expression that matches all the above keywords. The "[ =()]"
406 # bit is meant to avoid matching these keywords outside of boolean expressions.
407 #
408 # False positives include C-style multi-line comments and multi-line strings
409 # but those have always been troublesome for cpplint.
414 # These constants define types of headers for use with
415 # _IncludeState.CheckNextIncludeOrder().
422 # These constants define the current inline assembly state
428 # Match start of assembly blocks
430 r'(?:\s+(volatile|__volatile__))?'
434 _regexp_compile_cache = {}
436 # Finds occurrences of NOLINT or NOLINT(...).
439 # {str, set(int)}: a map from error categories to sets of linenumbers
440 # on which those errors are expected and should be suppressed.
441 _error_suppressions = {}
443 # The root directory used for deriving header guard CPP variable.
444 # This is set by --root flag.
447 # The allowed line length of files.
448 # This is set by --linelength flag.
451 # The allowed extensions for file names
452 # This is set by --extensions flag.
456 """Updates the global list of error-suppressions.
458 Parses any NOLINT comments on the current line, updating the global
459 error_suppressions store. Reports an error if the NOLINT comment
460 was malformed.
462 Args:
463 filename: str, the name of the input file.
464 raw_line: str, the line of input text, with comments.
465 linenum: int, the number of the current line.
466 error: function, an error handler.
467 """
468 # FIXME(adonovan): "NOLINT(" is misparsed as NOLINT(*).
485 "Resets the set of NOLINT suppressions to empty."
490 """Returns true if the specified error category is suppressed on this line.
492 Consults the global error_suppressions map populated by
493 ParseNolintSuppressions/ResetNolintSuppressions.
495 Args:
496 category: str, the category of the error.
497 linenum: int, the current line number.
498 Returns:
499 bool, True iff the error should be suppressed due to a NOLINT comment.
500 """
505 """Matches the string with the pattern, caching the compiled regexp."""
506 # The regexp compilation caching is inlined in both Match and Search for
507 # performance reasons; factoring it out into a separate function turns out
508 # to be noticeably expensive.
515 """Replaces instances of pattern in a string with a replacement.
517 The compiled regex is kept in a cache shared by Match and Search.
519 Args:
520 pattern: regex pattern
521 rep: replacement text
522 s: search string
524 Returns:
525 string with replacements made (or original string if no replacements)
526 """
533 """Searches the string for the pattern, caching the compiled regexp."""
540 """Tracks line numbers for includes, and the order in which includes appear.
542 As a dict, an _IncludeState object serves as a mapping between include
543 filename and line number on which that file was included.
545 Call CheckNextIncludeOrder() once for each header in the file, passing
546 in the type constants defined above. Calls in an illegal order will
547 raise an _IncludeError with an appropriate error message.
549 """
550 # self._section will move monotonically through this set. If it ever
551 # needs to move backwards, CheckNextIncludeOrder will raise an error.
558 _TYPE_NAMES = {
564 }
565 _SECTION_NAMES = {
571 }
578 # The name of the current section.
580 # The path of last found header.
587 """Returns a path canonicalized for alphabetical comparison.
589 - replaces "-" with "_" so they both cmp the same.
590 - removes '-inl' since we don't require them to be after the main header.
591 - lowercase everything, just in case.
593 Args:
594 header_path: Path to be canonicalized.
596 Returns:
597 Canonicalized path.
598 """
602 """Check if a header is in alphabetical order with the previous header.
604 Args:
605 clean_lines: A CleansedLines instance containing the file.
606 linenum: The number of the line to check.
607 header_path: Canonicalized header to be checked.
609 Returns:
610 Returns true if the header is in alphabetical order.
611 """
612 # If previous section is different from current section, _last_header will
613 # be reset to empty string, so it's always less than current header.
614 #
615 # If previous line was a blank line, assume that the headers are
616 # intentionally sorted the way they are.
619 return False
620 return True
623 """Returns a non-empty error message if the next header is out of order.
625 This function also updates the internal state to be ready to check
626 the next include.
628 Args:
629 header_type: One of the _XXX_HEADER constants defined above.
631 Returns:
632 The empty string if the header is in the right order, or an
633 error message describing what's wrong.
635 """
647 return error_message
653 return error_message
663 # This will always be the fallback because we're not sure
664 # enough that the header is associated with this file.
677 """Maintains module-wide state.."""
682 # filters to apply when emitting error messages
687 # output format:
688 # "emacs" - format that emacs can parse (default)
689 # "vs7" - format that Microsoft Visual Studio 7 can parse
693 """Sets the output format for errors."""
697 """Sets the module's verbosity, and returns the previous setting."""
700 return last_verbose_level
703 """Sets the module's counting options."""
707 """Sets the error-message filters.
709 These filters are applied when deciding whether to emit a given
710 error message.
712 Args:
713 filters: A string of comma-separated filters (eg "+whitespace/indent").
714 Each filter should start with + or -; else we die.
716 Raises:
717 ValueError: The comma-separated filters did not all start with '+' or '-'.
718 E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter"
719 """
720 # Default filters always have less priority than the flag ones.
732 """Sets the module's error statistic back to zero."""
737 """Bumps the module's error statistic."""
747 """Print a summary of errors by category, and the total."""
757 """Gets the module's output format."""
762 """Sets the module's output format."""
767 """Returns the module's verbosity setting."""
772 """Sets the module's verbosity, and returns the previous setting."""
777 """Sets the module's counting options."""
782 """Returns the module's list of output filters, as a list."""
787 """Sets the module's error-message filters.
789 These filters are applied when deciding whether to emit a given
790 error message.
792 Args:
793 filters: A string of comma-separated filters (eg "whitespace/indent").
794 Each filter should start with + or -; else we die.
795 """
800 """Tracks current function name and the number of lines in its body."""
811 """Start analyzing function body.
813 Args:
814 function_name: The name of the function being tracked.
815 """
821 """Count line in current function body."""
826 """Report if too many lines in function body.
828 Args:
829 error: The function to call with any errors found.
830 filename: The name of the current file.
831 linenum: The number of the line to check.
832 """
841 # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ...
845 'Small and focused functions are preferred:'
851 """Stop analyzing function body."""
856 """Indicates a problem with the include order in a file."""
857 pass
861 """Provides utility functions for filenames.
863 FileInfo provides easy access to the components of a file's path
864 relative to the project root.
865 """
871 """Make Windows paths like Unix."""
875 """FullName after removing the local path to the repository.
877 If we have a real absolute path name here we can try to do something smart:
878 detecting the root of the checkout and truncating /path/to/checkout from
879 the name so that we get header guards that don't include things like
880 "C:\Documents and Settings\..." or "/home/username/..." in them and thus
881 people on different computers who have checked the source out to different
882 locations won't see bogus errors.
883 """
890 # If there's a .svn file in the current directory, we recursively look
891 # up the directory tree for the top of the SVN checkout
892 root_dir = project_dir
901 # Not SVN <= 1.6? Try to find a git, hg, or svn top level directory by
902 # searching up from the current path.
916 # Don't know what to do; header guard warnings may be wrong...
917 return fullname
920 """Splits the file into the directory, basename, and extension.
922 For 'chrome/browser/browser.cc', Split() would
923 return ('chrome/browser', 'browser', '.cc')
925 Returns:
926 A tuple of (directory, basename, extension).
927 """
934 """File base name - text after the final slash, before the final period."""
938 """File extension - text following the final period."""
942 """File has no source file extension."""
946 """File has a source file extension."""
951 """If confidence >= verbose, category passes filter and is not suppressed."""
953 # There are three ways we might decide not to print an error message:
954 # a "NOLINT(category)" comment appears in the source,
955 # the verbosity level isn't high enough, or the filters filter it out.
957 return False
959 return False
972 return False
974 return True
978 """Logs the fact we've found a lint error.
980 We log where the error was found, and also our confidence in the error,
981 that is, how certain we are this is a legitimate style regression, and
982 not a misidentification or a use that's sometimes justified.
984 False positives can be suppressed by the use of
985 "cpplint(category)" comments on the offending line. These are
986 parsed into _error_suppressions.
988 Args:
989 filename: The name of the file containing the error.
990 linenum: The number of the line containing the error.
991 category: A string used to describe the "category" this bug
992 falls under: "whitespace", say, or "runtime". Categories
993 may have a hierarchy separated by slashes: "whitespace/indent".
994 confidence: A number from 1-5 representing a confidence score for
995 the error, with 5 meaning that we are certain of the problem,
996 and 1 meaning that it could be a legitimate construct.
997 message: The error message.
998 """
1012 # Matches standard C++ escape sequences per 2.13.2.3 of the C++ standard.
1015 # Matches strings. Escape codes should already be removed by ESCAPES.
1017 # Matches characters. Escape codes should already be removed by ESCAPES.
1019 # Matches multi-line C++ comments.
1020 # This RE is a little bit more complicated than one might expect, because we
1021 # have to take care of space removals tools so we can handle comments inside
1022 # statements better.
1023 # The current rule is: We only clear spaces from both sides when we're at the
1024 # end of the line. Otherwise, we try to remove spaces from the right side,
1025 # if this doesn't work we try on left side but only if there's a non-character
1026 # on the right.
1027 _RE_PATTERN_CLEANSE_LINE_C_COMMENTS = re.compile(
1028 r"""(\s*/\*.*\*/\s*$|
1029 /\*.*\*/\s+|
1030 \s+/\*.*\*/(?=\W)|
1031 /\*.*\*/)""", re.VERBOSE)
1034 def IsCppString(line):
1035 """Does line terminate so, that the next symbol is in string constant.
1037 This function does not consider single-line nor multi-line comments.
1039 Args:
1040 line: is a partial line of code starting from the 0..n.
1042 Returns:
1043 True, if next character appended to 'line' is inside a
1044 string constant.
1045 """
1052 """Removes C++11 raw strings from lines.
1054 Before:
1055 static const char kData[] = R"(
1056 multi-line string
1057 )";
1059 After:
1060 static const char kData[] = ""
1061 (replaced by blank line)
1062 "";
1064 Args:
1065 raw_lines: list of raw lines.
1067 Returns:
1068 list of lines with C++11 raw strings replaced by empty strings.
1069 """
1072 lines_without_raw_strings = []
1075 # Inside a raw string, look for the end
1078 # Found the end of the string, match leading space for this
1079 # line and resume copying the original lines, and also insert
1080 # a "" on the last line.
1085 # Haven't found the end yet, append a blank line.
1089 # Look for beginning of a raw string.
1090 # See 2.14.15 [lex.string] for syntax.
1097 # Raw string ended on same line
1102 # Start of a multi-line raw string
1107 # TODO(unknown): if delimiter is not None here, we might want to
1108 # emit a warning for unterminated string.
1109 return lines_without_raw_strings
1113 """Find the beginning marker for a multiline comment."""
1116 # Only return this marker if the comment goes beyond this line
1118 return lineix
1124 """We are inside a comment, find the end marker."""
1127 return lineix
1133 """Clears a range of lines for multi-line comments."""
1134 # Having // dummy comments makes the lines non-empty, so we will not get
1135 # unnecessary blank line warnings later in the code.
1141 """Removes multiline (c-style) comments from lines."""
1146 return
1151 return
1157 """Removes //-comments and single-line C-style /* */ comments.
1159 Args:
1160 line: A line of C++ source.
1162 Returns:
1163 The line with single-line comments removed.
1164 """
1168 # get rid of /* ... */
1173 """Holds 3 copies of all lines with different preprocessing applied to them.
1175 1) elided member contains lines without strings and comments,
1176 2) lines member contains lines without comments, and
1177 3) raw_lines member contains all the lines without processing.
1178 All these three members are of <type 'list'>, and of the same length.
1179 """
1194 """Returns the number of lines represented."""
1197 @staticmethod
1199 """Collapses strings and chars on a line to simple "" or '' blocks.
1201 We nix strings first so we're not fooled by text like '"http://"'
1203 Args:
1204 elided: The line being processed.
1206 Returns:
1207 The line with collapsed strings.
1208 """
1210 # Remove escaped characters first to make quote/single quote collapsing
1211 # basic. Things that look like escaped characters shouldn't occur
1212 # outside of strings and chars.
1216 return elided
1220 """Find the position just after the matching endchar.
1222 Args:
1223 line: a CleansedLines line.
1224 startpos: start searching at this position.
1225 depth: nesting level at startpos.
1226 startchar: expression opening character.
1227 endchar: expression closing character.
1229 Returns:
1230 On finding matching endchar: (index just after matching endchar, 0)
1231 Otherwise: (-1, new depth at end of this line)
1232 """
1244 """If input points to ( or { or [ or <, finds the position that closes it.
1246 If lines[linenum][pos] points to a '(' or '{' or '[' or '<', finds the
1247 linenum/pos that correspond to the closing of the expression.
1249 Args:
1250 clean_lines: A CleansedLines instance containing the file.
1251 linenum: The number of the line to check.
1252 pos: A position on the line.
1254 Returns:
1255 A tuple (line, linenum, pos) pointer *past* the closing brace, or
1256 (line, len(lines), -1) if we never find a close. Note we ignore
1257 strings and comments when matching; and the line we return is the
1258 'cleansed' line at linenum.
1259 """
1270 # Check first line
1276 # Continue scanning forward
1285 # Did not find endchar before end of file, give up
1290 """Find position at the matching startchar.
1292 This is almost the reverse of FindEndOfExpressionInLine, but note
1293 that the input position and returned position differs by 1.
1295 Args:
1296 line: a CleansedLines line.
1297 endpos: start searching at this position.
1298 depth: nesting level at endpos.
1299 startchar: expression opening character.
1300 endchar: expression closing character.
1302 Returns:
1303 On finding matching startchar: (index at matching startchar, 0)
1304 Otherwise: (-1, new depth at beginning of this line)
1305 """
1317 """If input points to ) or } or ] or >, finds the position that opens it.
1319 If lines[linenum][pos] points to a ')' or '}' or ']' or '>', finds the
1320 linenum/pos that correspond to the opening of the expression.
1322 Args:
1323 clean_lines: A CleansedLines instance containing the file.
1324 linenum: The number of the line to check.
1325 pos: A position on the line.
1327 Returns:
1328 A tuple (line, linenum, pos) pointer *at* the opening brace, or
1329 (line, 0, -1) if we never find the matching opening brace. Note
1330 we ignore strings and comments when matching; and the line we
1331 return is the 'cleansed' line at linenum.
1332 """
1342 # Check last line
1348 # Continue scanning backward
1357 # Did not find startchar before beginning of file, give up
1362 """Logs an error if no Copyright message appears at the top of the file."""
1364 # We'll say it should occur by line 10. Don't forget there's a
1365 # dummy line at the front.
1370 'No copyright message found. '
1375 """Returns the CPP variable that should be used as a header guard.
1377 Args:
1378 filename: The name of a C++ header file.
1380 Returns:
1381 The CPP variable that should be used as a header guard in the
1382 named file.
1384 """
1386 # Restores original filename in case that cpplint is invoked from Emacs's
1387 # flymake.
1399 """Checks that the file contains a header guard.
1401 Logs an error if no #ifndef header guard is present. For other
1402 headers, checks that the full pathname is used.
1404 Args:
1405 filename: The name of the C++ header file.
1406 lines: An array of strings, each representing a line of the file.
1407 error: The function to call with any errors found.
1408 """
1420 # find the first occurrence of #ifndef and #define, save arg
1422 # set ifndef to the header guard presented on the #ifndef line.
1424 ifndef_linenum = linenum
1427 # find the last occurrence of #endif, save entire line
1429 endif = line
1430 endif_linenum = linenum
1435 cppvar)
1436 return
1441 cppvar)
1442 return
1444 # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__
1445 # for backward compatibility.
1452 error)
1459 cppvar)
1460 return
1468 error)
1474 """Logs an error for each line containing bad characters.
1476 Two kinds of bad characters:
1478 1. Unicode replacement characters: These indicate that either the file
1479 contained invalid UTF-8 (likely) or Unicode replacement characters (which
1480 it shouldn't). Note that it's possible for this to throw off line
1481 numbering if the invalid UTF-8 occurred adjacent to a newline.
1483 2. NUL bytes. These are problematic for some tools.
1485 Args:
1486 filename: The name of the current file.
1487 lines: An array of strings, each representing a line of the file.
1488 error: The function to call with any errors found.
1489 """
1499 """Logs an error if there is no newline char at the end of the file.
1501 Args:
1502 filename: The name of the current file.
1503 lines: An array of strings, each representing a line of the file.
1504 error: The function to call with any errors found.
1505 """
1507 # The array lines() was created by adding two newlines to the
1508 # original file (go figure), then splitting on \n.
1509 # To verify that the file ends in \n, we just have to make sure the
1510 # last-but-two element of lines() exists and is empty.
1517 """Logs an error if we see /* ... */ or "..." that extend past one line.
1519 /* ... */ comments are legit inside macros, for one line.
1520 Otherwise, we prefer // comments, so it's ok to warn about the
1521 other. Likewise, it's ok for strings to extend across multiple
1522 lines, as long as a line continuation character (backslash)
1523 terminates each line. Although not currently prohibited by the C++
1524 style guide, it's ugly and unnecessary. We don't do well with either
1525 in this lint program, so we warn about both.
1527 Args:
1528 filename: The name of the current file.
1529 clean_lines: A CleansedLines instance containing the file.
1530 linenum: The number of the line to check.
1531 error: The function to call with any errors found.
1532 """
1535 # Remove all \\ (escaped backslashes) from the line. They are OK, and the
1536 # second (escaped) slash may trigger later \" detection erroneously.
1541 'Complex multi-line /*...*/-style comment found. '
1542 'Lint may give bogus warnings. '
1543 'Consider replacing these with //-style comments, '
1544 'with #if 0...#endif, '
1550 'do well with such strings, and may give bogus warnings. '
1554 threading_list = (
1567 )
1571 """Checks for calls to thread-unsafe functions.
1573 Much code has been originally written without consideration of
1574 multi-threading. Also, engineers are relying on their old experience;
1575 they have learned posix before threading extensions were added. These
1576 tests guide the engineers to use thread-safe functions (when using
1577 posix directly).
1579 Args:
1580 filename: The name of the current file.
1581 clean_lines: A CleansedLines instance containing the file.
1582 linenum: The number of the line to check.
1583 error: The function to call with any errors found.
1584 """
1588 # Comparisons made explicit for clarity -- pylint: disable=g-explicit-bool-comparison
1598 """Checks that VLOG() is only used for defining a logging level.
1600 For example, VLOG(2) is correct. VLOG(INFO), VLOG(WARNING), VLOG(ERROR), and
1601 VLOG(FATAL) are not.
1603 Args:
1604 filename: The name of the current file.
1605 clean_lines: A CleansedLines instance containing the file.
1606 linenum: The number of the line to check.
1607 error: The function to call with any errors found.
1608 """
1612 'VLOG() should be used with numeric verbosity level. '
1616 # Matches invalid increment: *count++, which moves pointer instead of
1617 # incrementing a value.
1623 """Checks for invalid increment *count++.
1625 For example following function:
1626 void increment_counter(int* count) {
1627 *count++;
1628 }
1629 is invalid, because it effectively does count++, moving pointer, and should
1630 be replaced with ++*count, (*count)++ or *count += 1.
1632 Args:
1633 filename: The name of the current file.
1634 clean_lines: A CleansedLines instance containing the file.
1635 linenum: The number of the line to check.
1636 error: The function to call with any errors found.
1637 """
1645 """Stores information about a generic block of code."""
1653 """Run checks that applies to text up to the opening brace.
1655 This is mostly for checking the text after the class identifier
1656 and the "{", usually where the base class is specified. For other
1657 blocks, there isn't much to check, so we always pass.
1659 Args:
1660 filename: The name of the current file.
1661 clean_lines: A CleansedLines instance containing the file.
1662 linenum: The number of the line to check.
1663 error: The function to call with any errors found.
1664 """
1665 pass
1668 """Run checks that applies to text after the closing brace.
1670 This is mostly used for checking end of namespace comments.
1672 Args:
1673 filename: The name of the current file.
1674 clean_lines: A CleansedLines instance containing the file.
1675 linenum: The number of the line to check.
1676 error: The function to call with any errors found.
1677 """
1678 pass
1682 """Stores information about a class."""
1696 # Remember initial indentation level for this class. Using raw_lines here
1697 # instead of elided to account for leading comments.
1704 # Try to find the end of the class. This will be confused by things like:
1705 # class A {
1706 # } *x = { ...
1707 #
1708 # But it's still good enough for CheckSectionSpacing.
1716 break
1719 # Look for a bare ':'
1724 # Check that closing brace is aligned with beginning of the class.
1725 # Only do this if the closing brace is indented by only whitespaces.
1726 # This means we will not check single-line class definitions.
1738 """Stores information about a namespace."""
1746 """Check end of namespace comments."""
1749 # Check how many lines is enclosed in this namespace. Don't issue
1750 # warning for missing namespace comments if there aren't enough
1751 # lines. However, do apply checks if there is already an end of
1752 # namespace comment and it's incorrect.
1753 #
1754 # TODO(unknown): We always want to check end of namespace comments
1755 # if a namespace is large, but sometimes we also want to apply the
1756 # check if a short namespace contained nontrivial things (something
1757 # other than forward declarations). There is currently no logic on
1758 # deciding what these nontrivial things are, so this check is
1759 # triggered by namespace size only, which works most of the time.
1762 return
1764 # Look for matching comment at end of namespace.
1765 #
1766 # Note that we accept C style "/* */" comments for terminating
1767 # namespaces, so that code that terminate namespaces inside
1768 # preprocessor macros can be cpplint clean.
1769 #
1770 # We also accept stuff like "// end of namespace <name>." with the
1771 # period at the end.
1772 #
1773 # Besides these, we don't accept anything else, otherwise we might
1774 # get false negatives when existing comment is a substring of the
1775 # expected namespace.
1777 # Named namespace
1780 line):
1785 # Anonymous namespace
1792 """Stores checkpoints of nesting stacks when #if/#else is seen."""
1795 # The entire nesting stack before #if
1798 # The entire nesting stack up to #else
1801 # Whether we have already seen #else or #elif
1806 """Holds states related to parsing braces."""
1809 # Stack for tracking all braces. An object is pushed whenever we
1810 # see a "{", and popped when we see a "}". Only 3 types of
1811 # objects are possible:
1812 # - _ClassInfo: a class or struct.
1813 # - _NamespaceInfo: a namespace.
1814 # - _BlockInfo: some other type of block.
1817 # Stack of _PreprocessorInfo objects.
1821 """Check if we have seen the opening brace for the innermost block.
1823 Returns:
1824 True if we have seen the opening brace, False if the innermost
1825 block is still expecting an opening brace.
1826 """
1830 """Check if we are currently one level inside a namespace body.
1832 Returns:
1833 True if top of the stack is a namespace block, False otherwise.
1834 """
1838 """Update preprocessor stack.
1840 We need to handle preprocessors due to classes like this:
1841 #ifdef SWIG
1842 struct ResultDetailsPageElementExtensionPoint {
1843 #else
1844 struct ResultDetailsPageElementExtensionPoint : public Extension {
1845 #endif
1847 We make the following assumptions (good enough for most files):
1848 - Preprocessor condition evaluates to true from #if up to first
1849 #else/#elif/#endif.
1851 - Preprocessor condition evaluates to false from #else/#elif up
1852 to #endif. We still perform lint checks on these lines, but
1853 these do not affect nesting stack.
1855 Args:
1856 line: current line to check.
1857 """
1859 # Beginning of #if block, save the nesting stack here. The saved
1860 # stack will allow us to restore the parsing state in the #else case.
1863 # Beginning of #else block
1866 # This is the first #else or #elif block. Remember the
1867 # whole nesting stack up to this point. This is what we
1868 # keep after the #endif.
1872 # Restore the stack to how it was before the #if
1875 # TODO(unknown): unexpected #else, issue warning?
1876 pass
1878 # End of #if or #else blocks.
1880 # If we saw an #else, we will need to restore the nesting
1881 # stack to its former state before the #else, otherwise we
1882 # will just continue from where we left off.
1884 # Here we can just use a shallow copy since we are the last
1885 # reference to it.
1887 # Drop the corresponding #if
1890 # TODO(unknown): unexpected #endif, issue warning?
1891 pass
1894 """Update nesting state with current line.
1896 Args:
1897 filename: The name of the current file.
1898 clean_lines: A CleansedLines instance containing the file.
1899 linenum: The number of the line to check.
1900 error: The function to call with any errors found.
1901 """
1904 # Update pp_stack first
1907 # Count parentheses. This is to avoid adding struct arguments to
1908 # the nesting stack.
1914 # Also check if we are starting or ending an inline assembly block.
1919 # Enter assembly block
1922 # Not entering assembly block. If previous line was _END_ASM,
1923 # we will now shift to _NO_ASM state.
1927 # Exit assembly block
1930 # Consume namespace declaration at the beginning of the line. Do
1931 # this in a loop so that we catch same line declarations like this:
1932 # namespace proto2 { namespace bridge { class MessageSet; } }
1934 # Match start of namespace. The "\b\s*" below catches namespace
1935 # declarations even if it weren't followed by a whitespace, this
1936 # is so that we don't confuse our namespace checker. The
1937 # missing spaces will be flagged by CheckSpacing.
1940 break
1950 # Look for a class declaration in whatever is left of the line
1951 # after parsing namespaces. The regexp accounts for decorated classes
1952 # such as in:
1953 # class LOCKABLE API Object {
1954 # };
1955 #
1956 # Templates with class arguments may confuse the parser, for example:
1957 # template <class T
1958 # class Comparator = less<T>,
1959 # class Vector = vector<T> >
1960 # class HeapQueue {
1961 #
1962 # Because this parser has no nesting state about templates, by the
1963 # time it saw "class Comparator", it may think that it's a new class.
1964 # Nested templates have a similar problem:
1965 # template <
1966 # typename ExportedType,
1967 # typename TupleType,
1968 # template <typename, typename> class ImplTemplate>
1969 #
1970 # To avoid these cases, we ignore classes that are followed by '=' or '>'
1972 r'\s*(template\s*<[\w\s<>,:]*>\s*)?'
1973 r'(class|struct)\s+([A-Z_]+\s+)*(\w+(?:::\w+)*)'
1982 # If we have not yet seen the opening brace for the innermost block,
1983 # run checks here.
1987 # Update access control if we are inside a class/struct
1991 r'^(.*)\b(public|private|protected|signals)(\s+(?:slots\s*)?)?'
1993 line)
1997 # Check that access keywords are indented +1 space. Skip this
1998 # check if the keywords are not preceded by whitespaces.
2013 # Consume braces or semicolons from what's left of the line
2015 # Match first brace, semicolon, or closed parenthesis.
2018 break
2022 # If namespace or class hasn't seen a opening brace yet, mark
2023 # namespace/class head as complete. Push a new block onto the
2024 # stack otherwise.
2032 # If we haven't seen an opening brace yet, but we already saw
2033 # a semicolon, this is probably a forward declaration. Pop
2034 # the stack for these.
2035 #
2036 # Similarly, if we haven't seen an opening brace yet, but we
2037 # already saw a closing parenthesis, then these are probably
2038 # function arguments with extra "class" or "struct" keywords.
2039 # Also pop these stack for these.
2043 # Perform end of block checks and pop the stack.
2050 """Get class info on the top of the stack.
2052 Returns:
2053 A _ClassInfo object if we are inside a class, or None otherwise.
2054 """
2058 return classinfo
2059 return None
2062 """Checks that all classes and namespaces have been completely parsed.
2064 Call this when all lines in a file have been processed.
2065 Args:
2066 filename: The name of the current file.
2067 error: The function to call with any errors found.
2068 """
2069 # Note: This test can result in false positives if #ifdef constructs
2070 # get in the way of brace matching. See the testBuildClass test in
2071 # cpplint_unittest.py for an example of this.
2085 r"""Logs an error if we see certain non-ANSI constructs ignored by gcc-2.
2087 Complain about several constructs which gcc-2 accepts, but which are
2088 not standard C++. Warning about these in lint is one way to ease the
2089 transition to new compilers.
2090 - put storage class first (e.g. "static const" instead of "const static").
2091 - "%lld" instead of %qd" in printf-type functions.
2092 - "%1$d" is non-standard in printf-type functions.
2093 - "\%" is an undefined character escape sequence.
2094 - text after #endif is not allowed.
2095 - invalid inner-style forward declaration.
2096 - >? and <? operators, and their >?= and <?= cousins.
2098 Additionally, check for constructor/destructor style violations and reference
2099 members, as it is very convenient to do so while checking for
2100 gcc-2 compliance.
2102 Args:
2103 filename: The name of the current file.
2104 clean_lines: A CleansedLines instance containing the file.
2105 linenum: The number of the line to check.
2106 nesting_state: A _NestingState instance which maintains information about
2107 the current stack of nested blocks being parsed.
2108 error: A callable to which errors are reported, which takes 4 arguments:
2109 filename, line number, error level, and message
2110 """
2112 # Remove comments from the line, but leave in strings for now.
2123 # Remove escaped backslashes before looking for undefined escapes.
2130 # For the rest, work with both comments and strings removed.
2131 line = clean_lines.elided[linenum]
2137 line):
2150 line):
2155 # TODO(unknown): Could it be expanded safely to arbitrary references,
2156 # without triggering too many false positives? The first
2157 # attempt triggered 5 warnings for mostly benign code in the regtest, hence
2158 # the restriction.
2159 # Here's the original regexp, for the reference:
2160 # type_name = r'\w+((\s*::\s*\w+)|(\s*<\s*\w+?\s*>))?'
2161 # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;'
2163 'const string& members are dangerous. It is much better to use '
2166 # Everything else in this function operates on class declarations.
2167 # Return early if the top of the nesting stack is not a class, or if
2168 # the class head is not completed yet.
2171 return
2173 # The class may have been declared with namespace or classname qualifiers.
2174 # The constructor and destructor will not have those qualifiers.
2177 # Look for single-argument constructors that aren't marked explicit.
2178 # Technically a valid construct, but against style.
2181 line)
2191 """Checks for the correctness of various spacing around function calls.
2193 Args:
2194 filename: The name of the current file.
2195 line: The text of the line to check.
2196 linenum: The number of the line to check.
2197 error: The function to call with any errors found.
2198 """
2200 # Since function calls often occur inside if/for/while/switch
2201 # expressions - which have their own, more liberal conventions - we
2202 # first see if we should be looking inside such an expression for a
2203 # function call, to which we can apply more strict standards.
2212 break
2214 # Except in if/for/while/switch, there should never be space
2215 # immediately inside parens (eg "f( 3, 4 )"). We make an exception
2216 # for nested parens ( (a+b) + c ). Likewise, there should never be
2217 # a space before a ( when it's a function argument. I assume it's a
2218 # function argument when the char before the whitespace is legal in
2219 # a function name (alnum + _) and we're not starting a macro. Also ignore
2220 # pointers and references to arrays and functions coz they're too tricky:
2221 # we use a very simple way to recognize these:
2222 # " (something)(maybe-something)" or
2223 # " (something)(maybe-something," or
2224 # " (something)[something]"
2225 # Note that we assume the contents of [] to be short enough that
2226 # they'll never need to wrap.
2230 # Ignore pointers/references to functions.
2232 # Ignore pointers/references to arrays.
2245 # If the ) is followed only by a newline or a { + newline, assume it's
2246 # part of a control statement (if/while/etc), and don't complain
2248 # If the closing parenthesis is preceded by only whitespaces,
2249 # try to give a more descriptive error message.
2259 """Returns true if the given line is blank.
2261 We consider a line to be blank if the line is empty or consists of
2262 only white spaces.
2264 Args:
2265 line: A line of a string.
2267 Returns:
2268 True, if the given line is blank.
2269 """
2275 """Reports for long function bodies.
2277 For an overview why this is done, see:
2278 http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions
2280 Uses a simplistic algorithm assuming other style guidelines
2281 (especially spacing) are followed.
2282 Only checks unindented functions, so class members are unchecked.
2283 Trivial bodies are unchecked, so constructors with huge initializer lists
2284 may be missed.
2285 Blank/comment lines are not counted so as to avoid encouraging the removal
2286 of vertical space and comments just to get through a lint check.
2287 NOLINT *on the last line of a function* disables this check.
2289 Args:
2290 filename: The name of the current file.
2291 clean_lines: A CleansedLines instance containing the file.
2292 linenum: The number of the line to check.
2293 function_state: Current function name and lines in body so far.
2294 error: The function to call with any errors found.
2295 """
2306 # If the name is all caps and underscores, figure it's a macro and
2307 # ignore it, unless it's TEST or TEST_F.
2331 break
2333 # No body for the function (or evidence of a non-function) was found.
2347 """Checks for common mistakes in TODO comments.
2349 Args:
2350 comment: The text of the comment from the line in question.
2351 filename: The name of the current file.
2352 linenum: The number of the line to check.
2353 error: The function to call with any errors found.
2354 """
2357 # One whitespace is correct; zero whitespace is handled elsewhere.
2366 'Missing username in TODO; it should look like '
2370 # Comparisons made explicit for correctness -- pylint: disable=g-explicit-bool-comparison
2376 """Checks for improper use of DISALLOW* macros.
2378 Args:
2379 filename: The name of the current file.
2380 clean_lines: A CleansedLines instance containing the file.
2381 linenum: The number of the line to check.
2382 nesting_state: A _NestingState instance which maintains information about
2383 the current stack of nested blocks being parsed.
2384 error: The function to call with any errors found.
2385 """
2389 r'DISALLOW_EVIL_CONSTRUCTORS|'
2392 return
2399 # Found DISALLOW* macro outside a class declaration, or perhaps it
2400 # was used inside a function when it should have been part of the
2401 # class declaration. We could issue a warning here, but it
2402 # probably resulted in a compiler error already.
2403 pass
2407 """Find the corresponding > to close a template.
2409 Args:
2410 clean_lines: A CleansedLines instance containing the file.
2411 linenum: Current line number.
2412 init_suffix: Remainder of the current line after the initial <.
2414 Returns:
2415 True if a matching bracket exists.
2416 """
2417 line = init_suffix
2420 # Find the next operator that can tell us whether < is used as an
2421 # opening bracket or as a less-than operator. We only want to
2422 # warn on the latter case.
2423 #
2424 # We could also check all other operators and terminate the search
2425 # early, e.g. if we got something like this "a<b+c", the "<" is
2426 # most likely a less-than operator, but then we will get false
2427 # positives for default arguments and other template expressions.
2430 # Found an operator, update nesting stack
2435 # Expecting closing angle bracket
2441 # Found matching angle bracket
2442 return True
2444 # Got a comma after a bracket, this is most likely a template
2445 # argument. We have not seen a closing angle bracket yet, but
2446 # it's probably a few lines later if we look for it, so just
2447 # return early here.
2448 return True
2450 # Got some other operator.
2451 return False
2454 # Expecting closing parenthesis or closing bracket
2458 # We don't bother checking for matching () or []. If we got
2459 # something like (] or [), it would have been a syntax error.
2463 # Scan the next line
2466 break
2469 # Exhausted all remaining lines and still no matching angle bracket.
2470 # Most likely the input was incomplete, otherwise we should have
2471 # seen a semicolon and returned early.
2472 return True
2476 """Find the corresponding < that started a template.
2478 Args:
2479 clean_lines: A CleansedLines instance containing the file.
2480 linenum: Current line number.
2481 init_prefix: Part of the current line before the initial >.
2483 Returns:
2484 True if a matching bracket exists.
2485 """
2486 line = init_prefix
2489 # Find the previous operator
2492 # Found an operator, update nesting stack
2497 # Expecting opening angle bracket
2503 # Found matching angle bracket
2504 return True
2506 # Got a comma before a bracket, this is most likely a
2507 # template argument. The opening angle bracket is probably
2508 # there if we look for it, so just return early here.
2509 return True
2511 # Got some other operator.
2512 return False
2515 # Expecting opening parenthesis or opening bracket
2522 # Scan the previous line
2525 break
2528 # Exhausted all earlier lines and still no matching angle bracket.
2529 return False
2533 """Checks for the correctness of various spacing issues in the code.
2535 Things we check for: spaces around operators, spaces after
2536 if/for/while/switch, no spaces around parens in function calls, two
2537 spaces between code and comment, don't start a block with a blank
2538 line, don't end a function with a blank line, don't add a blank line
2539 after public/protected/private, don't have too many blank lines in a row.
2541 Args:
2542 filename: The name of the current file.
2543 clean_lines: A CleansedLines instance containing the file.
2544 linenum: The number of the line to check.
2545 nesting_state: A _NestingState instance which maintains information about
2546 the current stack of nested blocks being parsed.
2547 error: The function to call with any errors found.
2548 """
2550 # Don't use "elided" lines here, otherwise we can't check commented lines.
2551 # Don't want to use "raw" either, because we don't want to check inside C++11
2552 # raw strings,
2556 # Before nixing comments, check if the line is blank for no good
2557 # reason. This includes the first line after a block is opened, and
2558 # blank lines at the end of a function (ie, right before a line like '}'
2559 #
2560 # Skip all the blank line checks if we are immediately inside a
2561 # namespace body. In other words, don't issue blank line warnings
2562 # for this block:
2563 # namespace {
2564 #
2565 # }
2566 #
2567 # A warning about missing end of namespace comments will be issued instead.
2572 # TODO(unknown): Don't complain if line before blank line, and line after,
2573 # both start with alnums and are indented the same amount.
2574 # This ignores whitespace at the start of a namespace block
2575 # because those are not usually indented.
2577 # OK, we have a blank line at the start of a code block. Before we
2578 # complain, we check if it is an exception to the rule: The previous
2579 # non-empty line has the parameters of a function header that are indented
2580 # 4 spaces (because they did not fit in a 80 column line when placed on
2581 # the same line as the function name). We also check for the case where
2582 # the previous line is indented 6 spaces, which may happen when the
2583 # initializers of a constructor do not fit into a 80 column line.
2586 # We are looking for the opening column of initializer list, which
2587 # should be indented 4 spaces to cause 6 space indentation afterwards.
2595 # Search for the function arguments or an initializer list. We use a
2596 # simple heuristic here: If the line is indented 4 spaces; and we have a
2597 # closing paren, without the opening paren, followed by an opening brace
2598 # or colon (for initializer lists) we assume that it is the last line of
2599 # a function header. If we have a colon indented 4 spaces, it is an
2600 # initializer list.
2602 prev_line)
2607 'Redundant blank line at the start of a code block '
2609 # Ignore blank lines at the end of a block in a long if-else
2610 # chain, like this:
2611 # if (condition1) {
2612 # // Something followed by a blank line
2613 #
2614 # } else if (condition2) {
2615 # // Something else
2616 # }
2623 'Redundant blank line at the end of a code block '
2631 # Next, we complain if there's a comment too near the text
2634 # Check if the // may be in quotes. If so, ignore it
2635 # Comparisons made explicit for clarity -- pylint: disable=g-explicit-bool-comparison
2638 # Allow one space for new scopes, two spaces otherwise:
2646 # There should always be a space between the // and the comment
2649 # but some lines are exceptions -- e.g. if they're big
2650 # comment delimiters like:
2651 # //----------------------------------------------------------
2652 # or are an empty C++ style Doxygen comment, like:
2653 # ///
2654 # or C++ style Doxygen comments placed after the variable:
2655 # ///< Header comment
2656 # //!< Header comment
2657 # or they begin with multiple slashes followed by a space:
2658 # //////// Header comment
2671 # Don't try to do spacing checks for operator methods
2674 # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )".
2675 # Otherwise not. Note we only check for non-spaces on *both* sides;
2676 # sometimes people put non-spaces on one side when aligning ='s among
2677 # many lines (not that this is behavior that I approve of...)
2682 # It's ok not to have spaces around binary operators like + - * /, but if
2683 # there's too little whitespace, we get concerned. It's hard to tell,
2684 # though, so we punt on this one for now. TODO.
2686 # You should always have whitespace around binary operators.
2687 #
2688 # Check <= and >= first to avoid false positives with < and >, then
2689 # check non-include lines for spacing around < and >.
2694 # We allow no-spaces around << when used like this: 10<<20, but
2695 # not otherwise (particularly, not when used as streams)
2696 # Also ignore using ns::operator<<;
2704 # Avoid false positives on ->
2707 # Look for < that is not surrounded by spaces. This is only
2708 # triggered if both sides are missing spaces, even though
2709 # technically should should flag if at least one side is missing a
2710 # space. This is done to avoid some false positives with shifts.
2717 # Look for > that is not surrounded by spaces. Similar to the
2718 # above, we only trigger if both sides are missing spaces to avoid
2719 # false positives with shifts.
2727 # We allow no-spaces around >> for almost anything. This is because
2728 # C++11 allows ">>" to close nested templates, which accounts for
2729 # most cases when ">>" is not followed by a space.
2730 #
2731 # We still warn on ">>" followed by alpha character, because that is
2732 # likely due to ">>" being used for right shifts, e.g.:
2733 # value >> alpha
2734 #
2735 # When ">>" is used to close templates, the alphanumeric letter that
2736 # follows would be part of an identifier, and there should still be
2737 # a space separating the template type and the identifier.
2738 # type<type<type>> alpha
2744 # There shouldn't be space around unary operators
2750 # A pet peeve of mine: no spaces after an if, while, switch, or for
2756 # For if/for/while/switch, the left and right parens should be
2757 # consistent about how many spaces are inside the parens, and
2758 # there should either be zero or one spaces inside the parens.
2759 # We don't want: "if ( foo)" or "if ( foo )".
2760 # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed.
2763 line)
2776 # You should always have a space after a comma (either as fn arg or operator)
2777 #
2778 # This does not apply when the non-space character following the
2779 # comma is another comma, since the only time when that happens is
2780 # for empty macro arguments.
2781 #
2782 # We run this check in two passes: first pass on elided lines to
2783 # verify that lines contain missing whitespaces, second pass on raw
2784 # lines to confirm that those missing whitespaces are not due to
2785 # elided comments.
2790 # You should always have a space after a semicolon
2791 # except for few corner cases
2792 # TODO(unknown): clarify if 'if (1) { return 1;}' is requires one more
2793 # space after ;
2798 # Next we will look for issues with function calls.
2801 # Except after an opening paren, or after another opening brace (in case of
2802 # an initializer list, for instance), you should have spaces before your
2803 # braces. And since you should never have braces at the beginning of a line,
2804 # this is an easy test.
2807 # Try a bit harder to check for brace initialization. This
2808 # happens in one of the following forms:
2809 # Constructor() : initializer_list_{} { ... }
2810 # Constructor{}.MemberFunction()
2811 # Type variable{};
2812 # FunctionCall(type{}, ...);
2813 # LastArgument(..., type{});
2814 # LOG(INFO) << type{} << " ...";
2815 # map_of_type[{...}] = ...;
2816 #
2817 # We check for the character following the closing brace, and
2818 # silence the warning if it's one of those listed above, i.e.
2819 # "{.;,)<]".
2820 #
2821 # To account for nested initializer list, we allow any number of
2822 # closing braces up to "{;,)<". We can't simply silence the
2823 # warning on first sight of closing brace, because that would
2824 # cause false negatives for things that are not initializer lists.
2825 # Silence this: But not this:
2826 # Outer{ if (...) {
2827 # Inner{...} if (...){ // Missing space before {
2828 # }; }
2829 #
2830 # There is a false negative with this approach if people inserted
2831 # spurious semicolons, e.g. "if (cond){};", but we will catch the
2832 # spurious semicolon with a separate check.
2845 # Make sure '} else {' has spaces.
2850 # You shouldn't have spaces before your brackets, except maybe after
2851 # 'delete []' or 'new char * []'.
2856 # You shouldn't have a space before a semicolon at the end of the line.
2857 # There's a special case for "for" since the style guide allows space before
2858 # the semicolon there.
2864 'Line contains only semicolon. If this should be an empty statement, '
2869 'Extra space before last semicolon. If this should be an empty '
2872 # In range-based for, we wanted spaces before and after the colon, but
2873 # not around "::" tokens that might appear.
2881 """Checks for additional blank line issues related to sections.
2883 Currently the only thing checked here is blank line before protected/private.
2885 Args:
2886 filename: The name of the current file.
2887 clean_lines: A CleansedLines instance containing the file.
2888 class_info: A _ClassInfo objects.
2889 linenum: The number of the line to check.
2890 error: The function to call with any errors found.
2891 """
2892 # Skip checks if the class is small, where small means 25 lines or less.
2893 # 25 lines seems like a good cutoff since that's the usual height of
2894 # terminals, and any class that can't fit in one screen can't really
2895 # be considered "small".
2896 #
2897 # Also skip checks if we are on the first line. This accounts for
2898 # classes that look like
2899 # class Foo { public: ... };
2900 #
2901 # If we didn't find the end of the class, last_line would be zero,
2902 # and the check will be skipped by the first condition.
2905 return
2909 # Issue warning if the line before public/protected/private was
2910 # not a blank line, but don't do this if the previous line contains
2911 # "class" or "struct". This can happen two ways:
2912 # - We are at the beginning of the class.
2913 # - We are forward-declaring an inner class that is semantically
2914 # private, but needed to be public for implementation reasons.
2915 # Also ignores cases where the previous line ends with a backslash as can be
2916 # common when defining classes in C macros.
2921 # Try a bit harder to find the beginning of the class. This is to
2922 # account for multi-line base-specifier lists, e.g.:
2923 # class Derived
2924 # : public Base {
2928 end_class_head = i
2929 break
2936 """Return the most recent non-blank line and its line number.
2938 Args:
2939 clean_lines: A CleansedLines instance containing the file contents.
2940 linenum: The number of the line to check.
2942 Returns:
2943 A tuple with two elements. The first element is the contents of the last
2944 non-blank line before the current line, or the empty string if this is the
2945 first non-blank line. The second is the line number of that line, or -1
2946 if this is the first non-blank line.
2947 """
2959 """Looks for misplaced braces (e.g. at the end of line).
2961 Args:
2962 filename: The name of the current file.
2963 clean_lines: A CleansedLines instance containing the file.
2964 linenum: The number of the line to check.
2965 error: The function to call with any errors found.
2966 """
2971 # We allow an open brace to start a line in the case where someone is using
2972 # braces in a block to explicitly create a new scope, which is commonly used
2973 # to control the lifetime of stack-allocated variables. Braces are also
2974 # used for brace initializers inside function calls. We don't detect this
2975 # perfectly: we just don't complain if the last non-whitespace character on
2976 # the previous non-blank line is ',', ';', ':', '(', '{', or '}', or if the
2977 # previous line starts a preprocessor block.
2984 # An else clause should be on the same line as the preceding closing brace.
2991 # If braces come on one side of an else, they should be on both.
2992 # However, we have to worry about "else if" that spans multiple lines!
2995 # find the ( after the if
3007 # Likewise, an else should never have the else clause on the same line
3012 # In the same way, a do/while should never be on one line
3017 # Block bodies should not be followed by a semicolon. Due to C++11
3018 # brace initialization, there are more places where semicolons are
3019 # required than not, so we use a whitelist approach to check these
3020 # rather than a blacklist. These are the places where "};" should
3021 # be replaced by just "}":
3022 # 1. Some flavor of block following closing parenthesis:
3023 # for (;;) {};
3024 # while (...) {};
3025 # switch (...) {};
3026 # Function(...) {};
3027 # if (...) {};
3028 # if (...) else if (...) {};
3029 #
3030 # 2. else block:
3031 # if (...) else {};
3032 #
3033 # 3. const member function:
3034 # Function(...) const {};
3035 #
3036 # 4. Block following some statement:
3037 # x = 42;
3038 # {};
3039 #
3040 # 5. Block at the beginning of a function:
3041 # Function(...) {
3042 # {};
3043 # }
3044 #
3045 # Note that naively checking for the preceding "{" will also match
3046 # braces inside multi-dimensional arrays, but this is fine since
3047 # that expression will not contain semicolons.
3048 #
3049 # 6. Block following another block:
3050 # while (true) {}
3051 # {};
3052 #
3053 # 7. End of namespaces:
3054 # namespace {};
3055 #
3056 # These semicolons seems far more common than other kinds of
3057 # redundant semicolons, possibly due to people converting classes
3058 # to namespaces. For now we do not warn for this case.
3059 #
3060 # Try matching case 1 first.
3063 # Matched closing parenthesis (case 1). Check the token before the
3064 # matching opening parenthesis, and don't warn if it looks like a
3065 # macro. This avoids these false positives:
3066 # - macro that defines a base class
3067 # - multi-line macro that defines a base class
3068 # - macro that defines the whole class-head
3069 #
3070 # But we still issue warnings for macros that we know are safe to
3071 # warn, specifically:
3072 # - TEST, TEST_F, TEST_P, MATCHER, MATCHER_P
3073 # - TYPED_TEST
3074 # - INTERFACE_DEF
3075 # - EXCLUSIVE_LOCKS_REQUIRED, SHARED_LOCKS_REQUIRED, LOCKS_EXCLUDED:
3076 #
3077 # We implement a whitelist of safe macros instead of a blacklist of
3078 # unsafe macros, even though the latter appears less frequently in
3079 # google code and would have been easier to implement. This is because
3080 # the downside for getting the whitelist wrong means some extra
3081 # semicolons, while the downside for getting the blacklist wrong
3082 # would result in compile errors.
3083 #
3084 # In addition to macros, we also don't want to warn on compound
3085 # literals.
3101 # Try matching cases 2-3.
3104 # Try matching cases 4-6. These are always matched on separate lines.
3105 #
3106 # Note that we can't simply concatenate the previous line to the
3107 # current line and do a single match, otherwise we may output
3108 # duplicate warnings for the blank line case:
3109 # if (cond) {
3110 # // blank line
3111 # }
3116 # Check matching closing brace
3121 # Current {} pair is eligible for semicolon check, and we have found
3122 # the redundant semicolon, output warning here.
3123 #
3124 # Note: because we are scanning forward for opening braces, and
3125 # outputting warnings for the matching closing brace, if there are
3126 # nested blocks with trailing semicolons, we will get the error
3127 # messages in reversed order.
3133 """Look for empty loop/conditional body with only a single semicolon.
3135 Args:
3136 filename: The name of the current file.
3137 clean_lines: A CleansedLines instance containing the file.
3138 linenum: The number of the line to check.
3139 error: The function to call with any errors found.
3140 """
3142 # Search for loop keywords at the beginning of the line. Because only
3143 # whitespaces are allowed before the keywords, this will also ignore most
3144 # do-while-loops, since those lines should start with closing brace.
3145 #
3146 # We also check "if" blocks here, since an empty conditional block
3147 # is likely an error.
3151 # Find the end of the conditional expression
3155 # Output warning if what follows the condition expression is a semicolon.
3156 # No warning for all other cases, including whitespace or newline, since we
3157 # have a separate check for semicolons preceded by whitespace.
3168 """Checks the use of CHECK and EXPECT macros.
3170 Args:
3171 filename: The name of the current file.
3172 clean_lines: A CleansedLines instance containing the file.
3173 linenum: The number of the line to check.
3174 error: The function to call with any errors found.
3175 """
3177 # Decide the set of replacement macros that should be suggested
3184 check_macro = macro
3186 # Find opening parenthesis. Do a regular expression match here
3187 # to make sure that we are matching the expected CHECK macro, as
3188 # opposed to some other macro that happens to contain the CHECK
3189 # substring.
3192 continue
3194 break
3196 # Don't waste time here if line doesn't contain 'CHECK' or 'EXPECT'
3197 return
3199 # Find end of the boolean expression by matching parentheses
3203 return
3212 # Parse expression so that we can take parentheses into account.
3213 # This avoids false positives for inputs like "CHECK((a < 4) == b)",
3214 # which is not replaceable by CHECK_LE.
3224 # Parenthesized operand
3232 # Logical and/or operators. This means the expression
3233 # contains more than one term, for example:
3234 # CHECK(42 < a && a < b);
3235 #
3236 # These are not replaceable with CHECK_LE, so bail out early.
3237 return
3239 # Non-relational operator
3240 lhs += token
3243 # Relational operator
3244 operator = token
3246 break
3248 # Unparenthesized operand. Instead of appending to lhs one character
3249 # at a time, we do another regular expression match to consume several
3250 # characters at once if possible. Trivial benchmark shows that this
3251 # is more efficient when the operands are longer than a single
3252 # character, which is generally the case.
3257 break
3261 # Only apply checks if we got all parts of the boolean expression
3263 return
3265 # Check that rhs do not contain logical operators. We already know
3266 # that lhs is fine since the loop above parses out && and ||.
3268 return
3270 # At least one of the operands must be a constant literal. This is
3271 # to avoid suggesting replacements for unprintable things like
3272 # CHECK(variable != iterator)
3273 #
3274 # The following pattern matches decimal, hex integers, strings, and
3275 # characters (in that order).
3279 if Match(match_constant, lhs) or Match(match_constant, rhs):
3280 # Note: since we know both lhs and rhs, we can provide a more
3281 # descriptive error message like:
3282 # Consider using CHECK_EQ(x, 42) instead of CHECK(x == 42)
3283 # Instead of:
3284 # Consider using CHECK_EQ instead of CHECK(a == b)
3285 #
3286 # We are still keeping the less descriptive message because if lhs
3287 # or rhs gets long, the error message might become unreadable.
3290 _CHECK_REPLACEMENT[check_macro][operator],
3291 check_macro, operator))
3294 def CheckAltTokens(filename, clean_lines, linenum, error):
3295 """Check alternative keywords being used in boolean expressions.
3297 Args:
3298 filename: The name of the current file.
3299 clean_lines: A CleansedLines instance containing the file.
3300 linenum: The number of the line to check.
3301 error: The function to call with any errors found.
3302 """
3303 line = clean_lines.elided[linenum]
3305 # Avoid preprocessor lines
3307 return
3309 # Last ditch effort to avoid multi-line comments. This will not help
3310 # if the comment started before the current line or ended after the
3311 # current line, but it catches most of the false positives. At least,
3312 # it provides a way to workaround this warning for people who use
3313 # multi-line comments in preprocessor macros.
3314 #
3315 # TODO(unknown): remove this once cpplint has better support for
3316 # multi-line comments.
3318 return
3327 """Determines the width of the line in column positions.
3329 Args:
3330 line: A string, which may be a Unicode string.
3332 Returns:
3333 The width of the line in column positions, accounting for Unicode
3334 combining characters and wide characters.
3335 """
3343 return width
3349 error):
3350 """Checks rules from the 'C++ style rules' section of cppguide.html.
3352 Most of these rules are hard to test (naming, comment style), but we
3353 do what we can. In particular we check for 2-space indents, line lengths,
3354 tab usage, spaces inside code, etc.
3356 Args:
3357 filename: The name of the current file.
3358 clean_lines: A CleansedLines instance containing the file.
3359 linenum: The number of the line to check.
3360 file_extension: The extension (without the dot) of the filename.
3361 nesting_state: A _NestingState instance which maintains information about
3362 the current stack of nested blocks being parsed.
3363 error: The function to call with any errors found.
3364 """
3366 # Don't use "elided" lines here, otherwise we can't check commented lines.
3367 # Don't want to use "raw" either, because we don't want to check inside C++11
3368 # raw strings,
3376 # One or three blank spaces at the beginning of the line is weird; it's
3377 # hard to reconcile that with 2-space indents.
3378 # NOTE: here are the conditions rob pike used for his tests. Mine aren't
3379 # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces
3380 # if(RLENGTH > 20) complain = 0;
3381 # if(match($0, " +(error|private|public|protected):")) complain = 0;
3382 # if(match(prev, "&& *$")) complain = 0;
3383 # if(match(prev, "\\|\\| *$")) complain = 0;
3384 # if(match(prev, "[\",=><] *$")) complain = 0;
3385 # if(match($0, " <<")) complain = 0;
3386 # if(match(prev, " +for \\(")) complain = 0;
3387 # if(prevodd && match(prevprev, " +for \\(")) complain = 0;
3395 # There are certain situations we allow one space, notably for section labels
3399 'Weird number of spaces at line-start. '
3402 # Check if the line is a header guard.
3410 # #include lines and header guards can be long, since there's no clean way to
3411 # split them.
3412 #
3413 # URLs can be long too. It's possible to split these, but it makes them
3414 # harder to cut&paste.
3415 #
3416 # The "$Id:...$" comment may also get very long without it being the
3417 # developers fault.
3426 extended_length)
3432 # for loops are allowed two ;'s (and may run over two lines).
3436 # It's ok to have many commands in a switch case that fits in 1 line
3443 # Some more style checks
3457 # Matches the first component of a filename delimited by -s and _s. That is:
3458 # _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo'
3459 # _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo'
3460 # _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo'
3461 # _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo'
3466 """Drops common suffixes like _test.cc or -inl.h from filename.
3468 For example:
3469 >>> _DropCommonSuffixes('foo/foo-inl.h')
3470 'foo/foo'
3471 >>> _DropCommonSuffixes('foo/bar/foo.cc')
3472 'foo/bar/foo'
3473 >>> _DropCommonSuffixes('foo/foo_internal.h')
3474 'foo/foo'
3475 >>> _DropCommonSuffixes('foo/foo_unusualinternal.h')
3476 'foo/foo_unusualinternal'
3478 Args:
3479 filename: The input filename.
3481 Returns:
3482 The filename with the common suffix removed.
3483 """
3493 """Determines if the given filename has a suffix that identifies it as a test.
3495 Args:
3496 filename: The input filename.
3498 Returns:
3499 True if 'filename' looks like a test, False otherwise.
3500 """
3504 return True
3506 return False
3510 """Figures out what kind of header 'include' is.
3512 Args:
3513 fileinfo: The current file cpplint is running over. A FileInfo instance.
3514 include: The path to a #included file.
3515 is_system: True if the #include used <> rather than "".
3517 Returns:
3518 One of the _XXX_HEADER constants.
3520 For example:
3521 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True)
3522 _C_SYS_HEADER
3523 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True)
3524 _CPP_SYS_HEADER
3525 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False)
3526 _LIKELY_MY_HEADER
3527 >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'),
3528 ... 'bar/foo_other_ext.h', False)
3529 _POSSIBLE_MY_HEADER
3530 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False)
3531 _OTHER_HEADER
3532 """
3533 # This is a list of all standard c++ header files, except
3534 # those already checked for above.
3539 return _CPP_SYS_HEADER
3541 return _C_SYS_HEADER
3543 # If the target file and the include we're checking share a
3544 # basename when we drop common extensions, and the include
3545 # lives in . , then it's likely to be owned by the target file.
3552 return _LIKELY_MY_HEADER
3554 # If the target and include share some initial basename
3555 # component, it's possible the target is implementing the
3556 # include, so it's allowed to be first, but we'll never
3557 # complain if it's not there.
3563 return _POSSIBLE_MY_HEADER
3565 return _OTHER_HEADER
3570 """Check rules that are applicable to #include lines.
3572 Strings on #include lines are NOT removed from elided line, to make
3573 certain tasks easier. However, to prevent false positives, checks
3574 applicable to #include lines in CheckLanguage must be put here.
3576 Args:
3577 filename: The name of the current file.
3578 clean_lines: A CleansedLines instance containing the file.
3579 linenum: The number of the line to check.
3580 include_state: An _IncludeState instance in which the headers are inserted.
3581 error: The function to call with any errors found.
3582 """
3587 # "include" should use the new style "foo/bar.h" instead of just "bar.h"
3592 # we shouldn't include a file more than once. actually, there are a
3593 # handful of instances where doing so is okay, but in general it's
3594 # not.
3606 # We want to ensure that headers appear in the right order:
3607 # 1) for foo.cc, foo.h (preferred location)
3608 # 2) c system files
3609 # 3) cpp system files
3610 # 4) for foo.cc, foo.h (deprecated location)
3611 # 5) other google headers
3612 #
3613 # We classify each include statement as one of those 5 types
3614 # using a number of techniques. The include_state object keeps
3615 # track of the highest type seen, and complains if we see a
3616 # lower type after that.
3630 # Look for any of the stream classes that are part of standard C++.
3635 # Many unit tests use cout, so we exempt them.
3642 r"""Retrieves all the text between matching open and close parentheses.
3644 Given a string of lines and a regular expression string, retrieve all the text
3645 following the expression and between opening punctuation symbols like
3646 (, [, or {, and the matching close-punctuation symbol. This properly nested
3647 occurrences of the punctuations, so for the text like
3648 printf(a(), b(c()));
3649 a call to _GetTextInside(text, r'printf\(') will return 'a(), b(c())'.
3650 start_pattern must match string having an open punctuation symbol at the end.
3652 Args:
3653 text: The lines to extract text. Its comments and strings must be elided.
3654 It can be single line and can span multiple lines.
3655 start_pattern: The regexp string indicating where to start extracting
3656 the text.
3657 Returns:
3658 The extracted text.
3659 None if either the opening string or ending punctuation could not be found.
3660 """
3661 # TODO(sugawarayu): Audit cpplint.py to see what places could be profitably
3662 # rewritten to use _GetTextInside (and use inferior regexp matching today).
3664 # Give opening punctuations to get the matching close-punctuations.
3668 # Find the position to start extracting text.
3671 return None
3678 # Stack of closing punctuations we expect to have in text after position.
3680 position = start_position
3685 # A closing punctuation without matching opening punctuations.
3686 return None
3691 # Opening punctuations left without matching close-punctuations.
3692 return None
3693 # punctuations match.
3697 # Patterns for matching call-by-reference parameters.
3698 #
3699 # Supports nested templates up to 2 levels deep using this messy pattern:
3700 # < (?: < (?: < [^<>]*
3701 # >
3702 # | [^<>] )*
3703 # >
3704 # | [^<>] )*
3705 # >
3707 _RE_PATTERN_TYPE = (
3708 r'(?:const\s+)?(?:typename\s+|class\s+|struct\s+|union\s+|enum\s+)?'
3709 r'(?:\w|'
3710 r'\s*<(?:<(?:<[^<>]*>|[^<>])*>|[^<>])*>|'
3712 # A call-by-reference parameter ends with '& identifier'.
3716 # A call-by-const-reference parameter either ends with 'const& identifier'
3717 # or looks like 'const type& identifier' when 'type' is atomic.
3718 _RE_PATTERN_CONST_REF_PARAM = (
3725 """Checks rules from the 'C++ language rules' section of cppguide.html.
3727 Some of these rules are hard to test (function overloading, using
3728 uint32 inappropriately), but we do the best we can.
3730 Args:
3731 filename: The name of the current file.
3732 clean_lines: A CleansedLines instance containing the file.
3733 linenum: The number of the line to check.
3734 file_extension: The extension (without the dot) of the filename.
3735 include_state: An _IncludeState instance in which the headers are inserted.
3736 nesting_state: A _NestingState instance which maintains information about
3737 the current stack of nested blocks being parsed.
3738 error: The function to call with any errors found.
3739 """
3740 # If the line is empty or consists of entirely a comment, no need to
3741 # check it.
3744 return
3749 return
3751 # Reset include state across preprocessor directives. This is meant
3752 # to silence warnings for conditional includes.
3756 # Make Windows paths like Unix.
3759 # TODO(unknown): figure out if they're using default arguments in fn proto.
3761 # Check to see if they're using an conversion function cast.
3762 # I just try to capture the most common basic types, though there are more.
3763 # Parameterless conversion functions, such as bool(), are allowed as they are
3764 # probably a member operator declaration or default constructor.
3767 r'(int|float|double|bool|char|int32|uint32|int64|uint64)'
3774 # gMock methods are defined using some variant of MOCK_METHODx(name, type)
3775 # where type may be float(), int(string), etc. Without context they are
3776 # virtually indistinguishable from int(x) casts. Likewise, gMock's
3777 # MockCallback takes a template parameter of the form return_type(arg_type),
3778 # which looks much like the cast we're trying to detect.
3779 #
3780 # std::function<> wrapper has a similar problem.
3781 #
3782 # Return types for function pointers also look like casts if they
3783 # don't have an extra space.
3790 matched_funcptr))):
3791 # Try a bit harder to catch gmock lines: the only place where
3792 # something looks like an old-style cast is where we declare the
3793 # return type of the mocked method, and the only time when we
3794 # are missing context is if MOCK_METHOD was split across
3795 # multiple lines. The missing MOCK_METHOD is usually one or two
3796 # lines back, so scan back one or two lines.
3797 #
3798 # It's not possible for gmock macros to appear in the first 2
3799 # lines, since the class head + section name takes up 2 lines.
3806 'Using deprecated casting style. '
3808 matched_type)
3814 # This doesn't catch all cases. Consider (const char * const)"hello".
3815 #
3816 # (char *) "foo" should always be a const_cast (reinterpret_cast won't
3817 # compile).
3820 pass
3822 # Check pointer casts for other than string constants
3826 # In addition, we look for people taking the address of a cast. This
3827 # is dangerous -- casts can assign to temporaries, so the pointer doesn't
3828 # point where you think.
3830 r'(?:&\(([^)]+)\)[\w(])|'
3835 'This is dangerous: could be a temp var. '
3838 # Create an extended_line, which is the concatenation of the current and
3839 # next lines, for more effective checking of code that may span more than one
3840 # line.
3844 extended_line = line
3846 # Check for people declaring static/global STL strings at the top level.
3847 # This is dangerous because the C++ language does not guarantee that
3848 # globals with constructors are initialized before the first access.
3851 line)
3852 # Make sure it's not a function.
3853 # Function template specialization looks like: "string foo<Type>(...".
3854 # Class template definitions look like: "string Foo<Type>::Method(...".
3855 #
3856 # Also ignore things that look like operators. These are matched separately
3857 # because operator names cross non-word boundaries. If we change the pattern
3858 # above, we would decrease the accuracy of matching identifiers.
3863 'For a static/global string constant, use a C style string instead: '
3872 # TODO(unknown): check that 1-arg constructors are explicit.
3873 # How to tell it's a constructor?
3874 # (handled in CheckForNonStandardConstructs for now)
3875 # TODO(unknown): check that classes have DISALLOW_EVIL_CONSTRUCTORS
3876 # (level 1 error)
3877 pass
3879 # Check if people are using the verboten C basic types. The only exception
3880 # we regularly allow is "unsigned short port" for port.
3891 # When snprintf is used, the second argument shouldn't be a literal.
3894 # If 2nd arg is zero, snprintf is used to calculate size.
3899 # Check if some verboten C functions are being used.
3908 # Check if some verboten operator overloading is going on
3909 # TODO(unknown): catch out-of-line unary operator&:
3910 # class X {};
3911 # int operator&(const X& x) { return 42; } // unary operator&
3912 # The trick is it's hard to tell apart from binary operator&:
3913 # class Y { int operator&(const Y& x) { return 23; } }; // binary operator&
3918 # Check for suspicious usage of "if" like
3919 # } if (a == b) {
3924 # Check for potential format string bugs like printf(foo).
3925 # We constrain the pattern not to pick things like DocidForPrintf(foo).
3926 # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str())
3927 # TODO(sugawarayu): Catch the following case. Need to change the calling
3928 # convention of the whole function to process multiple line to handle it.
3929 # printf(
3930 # boy_this_is_a_really_long_variable_that_cannot_fit_on_the_prev_line);
3941 # Check for potential memset bugs like memset(buf, sizeof(buf), 0).
3950 'Do not use namespace using-directives. '
3953 # Detect variable-length arrays.
3957 # Split the size using space and arithmetic operators as delimiters.
3958 # If any of the resulting tokens are not compile time constants then
3959 # report the error.
3966 continue
3979 # A catch all for tricky sizeof cases, including 'sizeof expression',
3980 # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)'
3981 # requires skipping the next token because we split on ' ' and '*'.
3984 continue
3986 break
3989 'Do not use variable-length arrays. Use an appropriately named '
3992 # If DISALLOW_EVIL_CONSTRUCTORS, DISALLOW_COPY_AND_ASSIGN, or
3993 # DISALLOW_IMPLICIT_CONSTRUCTORS is present, then it should be the last thing
3994 # in the class declaration.
3997 r'(DISALLOW_(EVIL_CONSTRUCTORS|COPY_AND_ASSIGN|IMPLICIT_CONSTRUCTORS))'
3999 line)
4002 # We allow some, but not all, declarations of variables to be present
4003 # in the statement that defines the class. The [\w\*,\s]* fragment of
4004 # the regular expression below allows users to declare instances of
4005 # the class or pointers to instances, but not less common types such
4006 # as function pointers or arrays. It's a tradeoff between allowing
4007 # reasonable code and avoiding trying to parse more C++ using regexps.
4012 # Check for use of unnamed namespaces in header files. Registration
4013 # macros are typically OK, so we allow use of "namespace {" on lines
4014 # that end with backslashes.
4019 'Do not use unnamed namespaces in header files. See '
4020 'http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces'
4025 """Check for non-const references.
4027 Separate from CheckLanguage since it scans backwards from current
4028 line, instead of scanning forward.
4030 Args:
4031 filename: The name of the current file.
4032 clean_lines: A CleansedLines instance containing the file.
4033 linenum: The number of the line to check.
4034 nesting_state: A _NestingState instance which maintains information about
4035 the current stack of nested blocks being parsed.
4036 error: The function to call with any errors found.
4037 """
4038 # Do nothing if there is no '&' on current line.
4041 return
4043 # Long type names may be broken across multiple lines, usually in one
4044 # of these forms:
4045 # LongType
4046 # ::LongTypeContinued &identifier
4047 # LongType::
4048 # LongTypeContinued &identifier
4049 # LongType<
4050 # ...>::LongTypeContinued &identifier
4051 #
4052 # If we detected a type split across two lines, join the previous
4053 # line to current line so that we can match const references
4054 # accordingly.
4055 #
4056 # Note that this only scans back one line, since scanning back
4057 # arbitrary number of lines would be expensive. If you have a type
4058 # that spans more than 2 lines, please use a typedef.
4062 # previous_line\n + ::current_line
4066 # previous_line::\n + current_line
4072 # Check for templated parameter that is split across multiple lines
4078 # Found the matching < on an earlier line, collect all
4079 # pieces up to current line.
4084 # Check for non-const references in function parameters. A single '&' may
4085 # found in the following places:
4086 # inside expression: binary & for bitwise AND
4087 # inside expression: unary & for taking the address of something
4088 # inside declarators: reference parameter
4089 # We will exclude the first two cases by checking that we are not inside a
4090 # function body, including one that was just introduced by a trailing '{'.
4091 # TODO(unknwon): Doesn't account for preprocessor directives.
4092 # TODO(unknown): Doesn't account for 'catch(Exception& e)' [rare].
4104 # We allow non-const references in a few standard places, like functions
4105 # called "swap()" or iostream operators like "<<" or ">>". Do not check
4106 # those function parameters.
4107 #
4108 # We also accept & in static_assert, which looks like a function but
4109 # it's actually a declaration expression.
4111 r'operator\s*[<>][<>]|'
4112 r'static_assert|COMPILE_ASSERT'
4117 # Don't see a whitelisted function on this line. Actually we
4118 # didn't see any function name on this line, so this is likely a
4119 # multi-line parameter list. Try a bit harder to catch this case.
4124 break
4131 'Is this a non-const reference? '
4137 error):
4138 """Checks for a C-style cast by looking for the pattern.
4140 Args:
4141 filename: The name of the current file.
4142 linenum: The number of the line to check.
4143 line: The line of code to check.
4144 raw_line: The raw line of code to check, with comments.
4145 cast_type: The string for the C++ cast to recommend. This is either
4146 reinterpret_cast, static_cast, or const_cast, depending.
4147 pattern: The regular expression used to find C-style casts.
4148 error: The function to call with any errors found.
4150 Returns:
4151 True if an error was emitted.
4152 False otherwise.
4153 """
4156 return False
4158 # e.g., sizeof(int)
4163 return True
4165 # operator++(int) and operator--(int)
4168 return False
4170 # A single unnamed argument for a function tends to look like old
4171 # style cast. If we see those, don't issue warnings for deprecated
4172 # casts, instead issue warnings for unnamed arguments where
4173 # appropriate.
4174 #
4175 # These are things that we want warnings for, since the style guide
4176 # explicitly require all parameters to be named:
4177 # Function(int);
4178 # Function(int) {
4179 # ConstMember(int) const;
4180 # ConstMember(int) const {
4181 # ExceptionMember(int) throw (...);
4182 # ExceptionMember(int) throw (...) {
4183 # PureVirtual(int) = 0;
4184 #
4185 # These are functions of some sort, where the compiler would be fine
4186 # if they had named parameters, but people often omit those
4187 # identifiers to reduce clutter:
4188 # (FunctionPointer)(int);
4189 # (FunctionPointer)(int) = value;
4190 # Function((function_pointer_arg)(int))
4191 # <TemplateArgument(int)>;
4192 # <(FunctionPointerTemplateArgument)(int)>;
4195 # Looks like an unnamed parameter.
4197 # Don't warn on any kind of template arguments.
4199 return False
4201 # Don't warn on assignments to function pointers, but keep warnings for
4202 # unnamed parameters to pure virtual functions. Note that this pattern
4203 # will also pass on assignments of "0" to function pointers, but the
4204 # preferred values for those would be "nullptr" or "NULL".
4207 return False
4209 # Don't warn on function pointer declarations. For this we need
4210 # to check what came before the "(type)" string.
4212 return False
4214 # Don't warn if the parameter is named with block comments, e.g.:
4215 # Function(int /*unused_param*/);
4217 return False
4219 # Passed all filters, issue warning here.
4222 return True
4224 # At this point, all that should be left is actual casts.
4229 return True
4232 _HEADERS_CONTAINING_TEMPLATES = (
4250 )),
4262 # gcc extensions.
4263 # Note: std::hash is their hash, ::hash is our hash
4267 )
4271 _re_pattern_algorithm_header = []
4274 # Match max<type>(..., ...), max(..., ...), but not foo->max, foo.max or
4275 # type::max().
4278 _template,
4281 _re_pattern_templates = []
4287 _header))
4291 """Check if these two filenames belong to the same module.
4293 The concept of a 'module' here is a as follows:
4294 foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the
4295 same 'module' if they are in the same directory.
4296 some/path/public/xyzzy and some/path/internal/xyzzy are also considered
4297 to belong to the same module here.
4299 If the filename_cc contains a longer path than the filename_h, for example,
4300 '/absolute/path/to/base/sysinfo.cc', and this file would include
4301 'base/sysinfo.h', this function also produces the prefix needed to open the
4302 header. This is used by the caller of this function to more robustly open the
4303 header file. We don't have access to the real include paths in this context,
4304 so we need this guesswork here.
4306 Known bugs: tools/base/bar.cc and base/bar.h belong to the same module
4307 according to this implementation. Because of this, this function gives
4308 some false positives. This should be sufficiently rare in practice.
4310 Args:
4311 filename_cc: is the path for the .cc file
4312 filename_h: is the path for the header path
4314 Returns:
4315 Tuple with a bool and a string:
4316 bool: True if filename_cc and filename_h belong to the same module.
4317 string: the additional prefix needed to open the header file.
4318 """
4346 """Fill up the include_state with new includes found from the file.
4348 Args:
4349 filename: the name of the header to read.
4350 include_state: an _IncludeState instance in which the headers are inserted.
4351 io: The io factory to use to read the file. Provided for testability.
4353 Returns:
4354 True if a header was succesfully added. False otherwise.
4355 """
4360 return False
4368 # The value formatting is cute, but not really used right now.
4369 # What matters here is that the key is in include_state.
4371 return True
4376 """Reports for missing stl includes.
4378 This function will output warnings to make sure you are including the headers
4379 necessary for the stl containers and functions that you use. We only give one
4380 reason to include a header. For example, if you use both equal_to<> and
4381 less<> in a .h file, only one (the latter in the file) of these will be
4382 reported as a reason to include the <functional>.
4384 Args:
4385 filename: The name of the current file.
4386 clean_lines: A CleansedLines instance containing the file.
4387 include_state: An _IncludeState instance.
4388 error: The function to call with any errors found.
4389 io: The IO factory to use to read the header file. Provided for unittest
4390 injection.
4391 """
4393 # Example of required: { '<functional>': (1219, 'less<>') }
4398 continue
4400 # String is special -- it is a non-templatized type in STL.
4403 # Don't warn about strings in non-STL namespaces:
4404 # (We check only the first match per line; good enough.)
4413 # The following function is just a speed up, no semantics are changed.
4415 continue
4421 # The policy is that if you #include something in foo.h you don't need to
4422 # include it again in foo.cc. Here, we will look at possible includes.
4423 # Let's copy the include_state so it is only messed up within this function.
4426 # Did we find the header for this file (if any) and succesfully load it?
4429 # Use the absolute path so that matching works properly.
4432 # For Emacs's flymake.
4433 # If cpplint is invoked from Emacs's flymake, a temporary file is generated
4434 # by flymake and that file name might end with '_flymake.cc'. In that case,
4435 # restore original file name here so that the corresponding header file can be
4436 # found.
4437 # e.g. If the file name is 'foo_flymake.cc', we should search for 'foo.h'
4438 # instead of 'foo_flymake.h'
4441 # include_state is modified during iteration, so we iterate over a copy of
4442 # the keys.
4450 # If we can't find the header file for a .cc, assume it's because we don't
4451 # know where to look. In that case we'll give up as we're not sure they
4452 # didn't include it in the .h file.
4453 # TODO(unknown): Do a better job of finding .h files so we are confident that
4454 # not having the .h file means there isn't one.
4456 return
4458 # All the lines have been processed, report the errors found.
4471 """Check that make_pair's template arguments are deduced.
4473 G++ 4.6 in C++0x mode fails badly if make_pair's template arguments are
4474 specified explicitly, and such use isn't intended in any case.
4476 Args:
4477 filename: The name of the current file.
4478 clean_lines: A CleansedLines instance containing the file.
4479 linenum: The number of the line to check.
4480 error: The function to call with any errors found.
4481 """
4487 'For C++11-compatibility, omit template arguments from make_pair'
4493 extra_check_functions=[]):
4494 """Processes a single line in the file.
4496 Args:
4497 filename: Filename of the file that is being processed.
4498 file_extension: The extension (dot not included) of the file.
4499 clean_lines: An array of strings, each representing a line of the file,
4500 with comments stripped.
4501 line: Number of line being processed.
4502 include_state: An _IncludeState instance in which the headers are inserted.
4503 function_state: A _FunctionState instance which counts function lines, etc.
4504 nesting_state: A _NestingState instance which maintains information about
4505 the current stack of nested blocks being parsed.
4506 error: A callable to which errors are reported, which takes 4 arguments:
4507 filename, line number, error level, and message
4508 extra_check_functions: An array of additional check functions that will be
4509 run on each source line. Each function takes 4
4510 arguments: filename, clean_lines, line, error
4511 """
4516 return
4533 extra_check_functions=[]):
4534 """Performs lint checks and reports any errors to the given error function.
4536 Args:
4537 filename: Filename of the file that is being processed.
4538 file_extension: The extension (dot not included) of the file.
4539 lines: An array of strings, each representing a line of the file, with the
4540 last element being empty if the file is terminated with a newline.
4541 error: A callable to which errors are reported, which takes 4 arguments:
4542 filename, line number, error level, and message
4543 extra_check_functions: An array of additional check functions that will be
4544 run on each source line. Each function takes 4
4545 arguments: filename, clean_lines, line, error
4546 """
4566 extra_check_functions)
4571 # We check here rather than inside ProcessLine so that we see raw
4572 # lines rather than "cleaned" lines.
4578 """Does google-lint on a single file.
4580 Args:
4581 filename: The name of the file to parse.
4583 vlevel: The level of errors to report. Every error of confidence
4584 >= verbose_level will be reported. 0 is a good default.
4586 extra_check_functions: An array of additional check functions that will be
4587 run on each source line. Each function takes 4
4588 arguments: filename, clean_lines, line, error
4589 """
4594 # Support the UNIX convention of using "-" for stdin. Note that
4595 # we are not opening the file with universal newline support
4596 # (which codecs doesn't support anyway), so the resulting lines do
4597 # contain trailing '\r' characters if we are reading a file that
4598 # has CRLF endings.
4599 # If after the split a trailing '\r' is present, it is removed
4600 # below. If it is not expected to be present (i.e. os.linesep !=
4601 # '\r\n' as in Windows), a warning is issued below if this file
4602 # is processed.
4613 # Remove trailing '\r'.
4622 return
4624 # Note, if no dot is found, this will give the entire filename as the ext.
4627 # When reading from stdin, the extension is unknown, so no cpplint tests
4628 # should rely on the extension.
4634 extra_check_functions)
4636 # Use 0 for linenum since outputting only one error for potentially
4637 # several lines.
4646 """Prints a brief usage string and exits, optionally with an error message.
4648 Args:
4649 message: The optional error message.
4650 """
4659 """Prints a list of all the error-categories used by error messages.
4661 These are the categories used to filter messages via --filter.
4662 """
4668 """Parses the command line arguments.
4670 This may set the output format and verbosity level as side-effects.
4672 Args:
4673 args: The command line arguments:
4675 Returns:
4676 The list of filenames to lint.
4677 """
4699 output_format = val
4703 filters = val
4709 counting_style = val
4711 global _root
4712 _root = val
4714 global _line_length
4720 global _valid_extensions
4734 return filenames
4740 # Change stderr to write with replacement characters so we don't die
4741 # if we try to print something containing non-ASCII characters.