| blob | 159dbbb07e5b2e3f46a2dff2edf1ac8db6439a97 |
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 # Here are some issues that I've had people identify in my code during reviews,
32 # that I think are possible to flag automatically in a lint tool. If these were
33 # caught by lint, it would save time both for myself and that of my reviewers.
34 # Most likely, some of these are beyond the scope of the current lint framework,
35 # but I think it is valuable to retain these wish-list items even if they cannot
36 # be immediately implemented.
37 #
38 # Suggestions
39 # -----------
40 # - Check for no 'explicit' for multi-arg ctor
41 # - Check for boolean assign RHS in parens
42 # - Check for ctor initializer-list colon position and spacing
43 # - Check that if there's a ctor, there should be a dtor
44 # - Check accessors that return non-pointer member variables are
45 # declared const
46 # - Check accessors that return non-const pointer member vars are
47 # *not* declared const
48 # - Check for using public includes for testing
49 # - Check for spaces between brackets in one-line inline method
50 # - Check for no assert()
51 # - Check for spaces surrounding operators
52 # - Check for 0 in pointer context (should be NULL)
53 # - Check for 0 in char context (should be '\0')
54 # - Check for camel-case method name conventions for methods
55 # that are not simple inline getters and setters
56 # - Do not indent namespace contents
57 # - Avoid inlining non-trivial constructors in header files
58 # - Check for old-school (void) cast for call-sites of functions
59 # ignored return value
60 # - Check gUnit usage of anonymous namespace
61 # - Check for class declaration order (typedefs, consts, enums,
62 # ctor(s?), dtor, friend declarations, methods, member vars)
63 #
65 """Does google-lint on c++ files.
67 The goal of this script is to identify places in the code that *may*
68 be in non-compliance with google style. It does not attempt to fix
69 up these problems -- the point is to educate. It does also not
70 attempt to find all problems, or to ensure that everything it does
71 find is legitimately a problem.
73 In particular, we can get very confused by /* and // inside strings!
74 We do a small hack, which is to ignore //'s with "'s after them on the
75 same line, but it is far from perfect (in either direction).
76 """
78 import codecs
79 import copy
80 import getopt
82 import os
83 import re
84 import sre_compile
85 import string
86 import sys
87 import unicodedata
91 Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]
92 [--counting=total|toplevel|detailed]
93 <file> [file] ...
95 The style guidelines this tries to follow are those in
96 http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
98 Every problem is given a confidence score from 1-5, with 5 meaning we are
99 certain of the problem, and 1 meaning it could be a legitimate construct.
100 This will miss some errors, and is not a substitute for a code review.
102 To suppress false-positive errors of a certain category, add a
103 'NOLINT(category)' comment to the line. NOLINT or NOLINT(*)
104 suppresses errors of all categories on that line.
106 The files passed in will be linted; at least one file must be provided.
107 Linted extensions are .cc, .cpp, and .h. Other file types will be ignored.
109 Flags:
111 output=vs7
112 By default, the output is formatted to ease emacs parsing. Visual Studio
113 compatible output (vs7) may also be used. Other formats are unsupported.
115 verbose=#
116 Specify a number 0-5 to restrict errors to certain verbosity levels.
118 filter=-x,+y,...
119 Specify a comma-separated list of category-filters to apply: only
120 error messages whose category names pass the filters will be printed.
121 (Category names are printed with the message and look like
122 "[whitespace/indent]".) Filters are evaluated left to right.
123 "-FOO" and "FOO" means "do not print categories that start with FOO".
124 "+FOO" means "do print categories that start with FOO".
126 Examples: --filter=-whitespace,+whitespace/braces
127 --filter=whitespace,runtime/printf,+runtime/printf_format
128 --filter=-,+build/include_what_you_use
130 To see a list of all the categories used in cpplint, pass no arg:
131 --filter=
133 counting=total|toplevel|detailed
134 The total number of errors found is always printed. If
135 'toplevel' is provided, then the count of errors in each of
136 the top-level categories like 'build' and 'whitespace' will
137 also be printed. If 'detailed' is provided, then a count
138 is provided for each category like 'build/class'.
140 root=subdir
141 The root directory used for deriving header guard CPP variable.
142 By default, the header guard CPP variable is calculated as the relative
143 path to the directory that contains .git, .hg, or .svn. When this flag
144 is specified, the relative path is calculated from the specified
145 directory. If the specified directory does not exist, this flag is
146 ignored.
148 Examples:
149 Assuing that src/.git exists, the header guard CPP variables for
150 src/chrome/browser/ui/browser.h are:
152 No flag => CHROME_BROWSER_UI_BROWSER_H_
153 --root=chrome => BROWSER_UI_BROWSER_H_
154 --root=chrome/browser => UI_BROWSER_H_
155 """
157 # We categorize each error message we print. Here are the categories.
158 # We want an explicit list so we can list them all in cpplint --filter=.
159 # If you add a new error message with a new category, add it to the list
160 # here! cpplint_unittest.py should tell you if you forget to do this.
161 # \ used for clearer layout -- pylint: disable-msg=C6013
162 _ERROR_CATEGORIES = [
223 'whitespace/todo'
224 ]
226 # The default state of the category filter. This is overrided by the --filter=
227 # flag. By default all errors are on, so only add here categories that should be
228 # off by default (i.e., categories that must be enabled by the --filter= flags).
229 # All entries here should start with a '-' or '+', as in the --filter= flag.
232 # We used to check for high-bit characters, but after much discussion we
233 # decided those were OK, as long as they were in UTF-8 and didn't represent
234 # hard-coded international strings, which belong in a separate i18n file.
236 # Headers that we consider STL headers.
244 ])
247 # Non-STL C++ system headers.
262 ])
265 # Assertion macros. These are defined in base/logging.h and
266 # testing/base/gunit.h. Note that the _M versions need to come first
267 # for substring matching to work.
268 _CHECK_MACROS = [
274 ]
276 # Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE
297 # Alternative tokens and their replacements. For full list, see section 2.5
298 # Alternative tokens [lex.digraph] in the C++ standard.
299 #
300 # Digraphs (such as '%:') are not included here since it's a mess to
301 # match those on a word boundary.
302 _ALT_TOKEN_REPLACEMENT = {
314 }
316 # Compile regular expression that matches all the above keywords. The "[ =()]"
317 # bit is meant to avoid matching these keywords outside of boolean expressions.
318 #
319 # False positives include C-style multi-line comments (http://go/nsiut )
320 # and multi-line strings (http://go/beujw ), but those have always been
321 # troublesome for cpplint.
326 # These constants define types of headers for use with
327 # _IncludeState.CheckNextIncludeOrder().
334 # These constants define the current inline assembly state
340 # Match start of assembly blocks
342 r'(?:\s+(volatile|__volatile__))?'
346 _regexp_compile_cache = {}
348 # Finds occurrences of NOLINT or NOLINT(...).
351 # {str, set(int)}: a map from error categories to sets of linenumbers
352 # on which those errors are expected and should be suppressed.
353 _error_suppressions = {}
355 # The root directory used for deriving header guard CPP variable.
356 # This is set by --root flag.
360 """Updates the global list of error-suppressions.
362 Parses any NOLINT comments on the current line, updating the global
363 error_suppressions store. Reports an error if the NOLINT comment
364 was malformed.
366 Args:
367 filename: str, the name of the input file.
368 raw_line: str, the line of input text, with comments.
369 linenum: int, the number of the current line.
370 error: function, an error handler.
371 """
372 # FIXME(adonovan): "NOLINT(" is misparsed as NOLINT(*).
389 "Resets the set of NOLINT suppressions to empty."
394 """Returns true if the specified error category is suppressed on this line.
396 Consults the global error_suppressions map populated by
397 ParseNolintSuppressions/ResetNolintSuppressions.
399 Args:
400 category: str, the category of the error.
401 linenum: int, the current line number.
402 Returns:
403 bool, True iff the error should be suppressed due to a NOLINT comment.
404 """
409 """Matches the string with the pattern, caching the compiled regexp."""
410 # The regexp compilation caching is inlined in both Match and Search for
411 # performance reasons; factoring it out into a separate function turns out
412 # to be noticeably expensive.
419 """Searches the string for the pattern, caching the compiled regexp."""
426 """Tracks line numbers for includes, and the order in which includes appear.
428 As a dict, an _IncludeState object serves as a mapping between include
429 filename and line number on which that file was included.
431 Call CheckNextIncludeOrder() once for each header in the file, passing
432 in the type constants defined above. Calls in an illegal order will
433 raise an _IncludeError with an appropriate error message.
435 """
436 # self._section will move monotonically through this set. If it ever
437 # needs to move backwards, CheckNextIncludeOrder will raise an error.
444 _TYPE_NAMES = {
450 }
451 _SECTION_NAMES = {
457 }
461 # The name of the current section.
463 # The path of last found header.
467 """Returns a path canonicalized for alphabetical comparison.
469 - replaces "-" with "_" so they both cmp the same.
470 - removes '-inl' since we don't require them to be after the main header.
471 - lowercase everything, just in case.
473 Args:
474 header_path: Path to be canonicalized.
476 Returns:
477 Canonicalized path.
478 """
482 """Check if a header is in alphabetical order with the previous header.
484 Args:
485 header_path: Header to be checked.
487 Returns:
488 Returns true if the header is in alphabetical order.
489 """
492 return False
494 return True
497 """Returns a non-empty error message if the next header is out of order.
499 This function also updates the internal state to be ready to check
500 the next include.
502 Args:
503 header_type: One of the _XXX_HEADER constants defined above.
505 Returns:
506 The empty string if the header is in the right order, or an
507 error message describing what's wrong.
509 """
521 return error_message
527 return error_message
537 # This will always be the fallback because we're not sure
538 # enough that the header is associated with this file.
551 """Maintains module-wide state.."""
556 # filters to apply when emitting error messages
561 # output format:
562 # "emacs" - format that emacs can parse (default)
563 # "vs7" - format that Microsoft Visual Studio 7 can parse
567 """Sets the output format for errors."""
571 """Sets the module's verbosity, and returns the previous setting."""
574 return last_verbose_level
577 """Sets the module's counting options."""
581 """Sets the error-message filters.
583 These filters are applied when deciding whether to emit a given
584 error message.
586 Args:
587 filters: A string of comma-separated filters (eg "+whitespace/indent").
588 Each filter should start with + or -; else we die.
590 Raises:
591 ValueError: The comma-separated filters did not all start with '+' or '-'.
592 E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter"
593 """
594 # Default filters always have less priority than the flag ones.
606 """Sets the module's error statistic back to zero."""
611 """Bumps the module's error statistic."""
621 """Print a summary of errors by category, and the total."""
631 """Gets the module's output format."""
636 """Sets the module's output format."""
641 """Returns the module's verbosity setting."""
646 """Sets the module's verbosity, and returns the previous setting."""
651 """Sets the module's counting options."""
656 """Returns the module's list of output filters, as a list."""
661 """Sets the module's error-message filters.
663 These filters are applied when deciding whether to emit a given
664 error message.
666 Args:
667 filters: A string of comma-separated filters (eg "whitespace/indent").
668 Each filter should start with + or -; else we die.
669 """
674 """Tracks current function name and the number of lines in its body."""
685 """Start analyzing function body.
687 Args:
688 function_name: The name of the function being tracked.
689 """
695 """Count line in current function body."""
700 """Report if too many lines in function body.
702 Args:
703 error: The function to call with any errors found.
704 filename: The name of the current file.
705 linenum: The number of the line to check.
706 """
715 # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ...
719 'Small and focused functions are preferred:'
725 """Stop analyzing function body."""
730 """Indicates a problem with the include order in a file."""
731 pass
735 """Provides utility functions for filenames.
737 FileInfo provides easy access to the components of a file's path
738 relative to the project root.
739 """
745 """Make Windows paths like Unix."""
749 """FullName after removing the local path to the repository.
751 If we have a real absolute path name here we can try to do something smart:
752 detecting the root of the checkout and truncating /path/to/checkout from
753 the name so that we get header guards that don't include things like
754 "C:\Documents and Settings\..." or "/home/username/..." in them and thus
755 people on different computers who have checked the source out to different
756 locations won't see bogus errors.
757 """
764 # If there's a .svn file in the current directory, we recursively look
765 # up the directory tree for the top of the SVN checkout
766 root_dir = project_dir
775 # Not SVN <= 1.6? Try to find a git, hg, or svn top level directory by
776 # searching up from the current path.
790 # Don't know what to do; header guard warnings may be wrong...
791 return fullname
794 """Splits the file into the directory, basename, and extension.
796 For 'chrome/browser/browser.cc', Split() would
797 return ('chrome/browser', 'browser', '.cc')
799 Returns:
800 A tuple of (directory, basename, extension).
801 """
808 """File base name - text after the final slash, before the final period."""
812 """File extension - text following the final period."""
816 """File has no source file extension."""
820 """File has a source file extension."""
825 """If confidence >= verbose, category passes filter and is not suppressed."""
827 # There are three ways we might decide not to print an error message:
828 # a "NOLINT(category)" comment appears in the source,
829 # the verbosity level isn't high enough, or the filters filter it out.
831 return False
833 return False
846 return False
848 return True
852 """Logs the fact we've found a lint error.
854 We log where the error was found, and also our confidence in the error,
855 that is, how certain we are this is a legitimate style regression, and
856 not a misidentification or a use that's sometimes justified.
858 False positives can be suppressed by the use of
859 "cpplint(category)" comments on the offending line. These are
860 parsed into _error_suppressions.
862 Args:
863 filename: The name of the file containing the error.
864 linenum: The number of the line containing the error.
865 category: A string used to describe the "category" this bug
866 falls under: "whitespace", say, or "runtime". Categories
867 may have a hierarchy separated by slashes: "whitespace/indent".
868 confidence: A number from 1-5 representing a confidence score for
869 the error, with 5 meaning that we are certain of the problem,
870 and 1 meaning that it could be a legitimate construct.
871 message: The error message.
872 """
883 # Matches standard C++ escape esequences per 2.13.2.3 of the C++ standard.
886 # Matches strings. Escape codes should already be removed by ESCAPES.
888 # Matches characters. Escape codes should already be removed by ESCAPES.
890 # Matches multi-line C++ comments.
891 # This RE is a little bit more complicated than one might expect, because we
892 # have to take care of space removals tools so we can handle comments inside
893 # statements better.
894 # The current rule is: We only clear spaces from both sides when we're at the
895 # end of the line. Otherwise, we try to remove spaces from the right side,
896 # if this doesn't work we try on left side but only if there's a non-character
897 # on the right.
898 _RE_PATTERN_CLEANSE_LINE_C_COMMENTS = re.compile(
899 r"""(\s*/\*.*\*/\s*$|
900 /\*.*\*/\s+|
901 \s+/\*.*\*/(?=\W)|
902 /\*.*\*/)""", re.VERBOSE)
905 def IsCppString(line):
906 """Does line terminate so, that the next symbol is in string constant.
908 This function does not consider single-line nor multi-line comments.
910 Args:
911 line: is a partial line of code starting from the 0..n.
913 Returns:
914 True, if next character appended to 'line' is inside a
915 string constant.
916 """
923 """Find the beginning marker for a multiline comment."""
926 # Only return this marker if the comment goes beyond this line
928 return lineix
934 """We are inside a comment, find the end marker."""
937 return lineix
943 """Clears a range of lines for multi-line comments."""
944 # Having // dummy comments makes the lines non-empty, so we will not get
945 # unnecessary blank line warnings later in the code.
951 """Removes multiline (c-style) comments from lines."""
956 return
961 return
967 """Removes //-comments and single-line C-style /* */ comments.
969 Args:
970 line: A line of C++ source.
972 Returns:
973 The line with single-line comments removed.
974 """
978 # get rid of /* ... */
983 """Holds 3 copies of all lines with different preprocessing applied to them.
985 1) elided member contains lines without strings and comments,
986 2) lines member contains lines without comments, and
987 3) raw_lines member contains all the lines without processing.
988 All these three members are of <type 'list'>, and of the same length.
989 """
1002 """Returns the number of lines represented."""
1005 @staticmethod
1007 """Collapses strings and chars on a line to simple "" or '' blocks.
1009 We nix strings first so we're not fooled by text like '"http://"'
1011 Args:
1012 elided: The line being processed.
1014 Returns:
1015 The line with collapsed strings.
1016 """
1018 # Remove escaped characters first to make quote/single quote collapsing
1019 # basic. Things that look like escaped characters shouldn't occur
1020 # outside of strings and chars.
1024 return elided
1028 """Find the position just after the matching endchar.
1030 Args:
1031 line: a CleansedLines line.
1032 startpos: start searching at this position.
1033 depth: nesting level at startpos.
1034 startchar: expression opening character.
1035 endchar: expression closing character.
1037 Returns:
1038 Index just after endchar.
1039 """
1051 """If input points to ( or { or [, finds the position that closes it.
1053 If lines[linenum][pos] points to a '(' or '{' or '[', finds the
1054 linenum/pos that correspond to the closing of the expression.
1056 Args:
1057 clean_lines: A CleansedLines instance containing the file.
1058 linenum: The number of the line to check.
1059 pos: A position on the line.
1061 Returns:
1062 A tuple (line, linenum, pos) pointer *past* the closing brace, or
1063 (line, len(lines), -1) if we never find a close. Note we ignore
1064 strings and comments when matching; and the line we return is the
1065 'cleansed' line at linenum.
1066 """
1076 # Check first line
1089 num_open += delta
1091 # Did not find endchar before end of file, give up
1095 """Logs an error if no Copyright message appears at the top of the file."""
1097 # We'll say it should occur by line 10. Don't forget there's a
1098 # dummy line at the front.
1103 'No copyright message found. '
1108 """Returns the CPP variable that should be used as a header guard.
1110 Args:
1111 filename: The name of a C++ header file.
1113 Returns:
1114 The CPP variable that should be used as a header guard in the
1115 named file.
1117 """
1119 # Restores original filename in case that cpplint is invoked from Emacs's
1120 # flymake.
1132 """Checks that the file contains a header guard.
1134 Logs an error if no #ifndef header guard is present. For other
1135 headers, checks that the full pathname is used.
1137 Args:
1138 filename: The name of the C++ header file.
1139 lines: An array of strings, each representing a line of the file.
1140 error: The function to call with any errors found.
1141 """
1153 # find the first occurrence of #ifndef and #define, save arg
1155 # set ifndef to the header guard presented on the #ifndef line.
1157 ifndef_linenum = linenum
1160 # find the last occurrence of #endif, save entire line
1162 endif = line
1163 endif_linenum = linenum
1168 cppvar)
1169 return
1174 cppvar)
1175 return
1177 # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__
1178 # for backward compatibility.
1185 error)
1192 cppvar)
1193 return
1201 error)
1207 """Logs an error for each line containing Unicode replacement characters.
1209 These indicate that either the file contained invalid UTF-8 (likely)
1210 or Unicode replacement characters (which it shouldn't). Note that
1211 it's possible for this to throw off line numbering if the invalid
1212 UTF-8 occurred adjacent to a newline.
1214 Args:
1215 filename: The name of the current file.
1216 lines: An array of strings, each representing a line of the file.
1217 error: The function to call with any errors found.
1218 """
1226 """Logs an error if there is no newline char at the end of the file.
1228 Args:
1229 filename: The name of the current file.
1230 lines: An array of strings, each representing a line of the file.
1231 error: The function to call with any errors found.
1232 """
1234 # The array lines() was created by adding two newlines to the
1235 # original file (go figure), then splitting on \n.
1236 # To verify that the file ends in \n, we just have to make sure the
1237 # last-but-two element of lines() exists and is empty.
1244 """Logs an error if we see /* ... */ or "..." that extend past one line.
1246 /* ... */ comments are legit inside macros, for one line.
1247 Otherwise, we prefer // comments, so it's ok to warn about the
1248 other. Likewise, it's ok for strings to extend across multiple
1249 lines, as long as a line continuation character (backslash)
1250 terminates each line. Although not currently prohibited by the C++
1251 style guide, it's ugly and unnecessary. We don't do well with either
1252 in this lint program, so we warn about both.
1254 Args:
1255 filename: The name of the current file.
1256 clean_lines: A CleansedLines instance containing the file.
1257 linenum: The number of the line to check.
1258 error: The function to call with any errors found.
1259 """
1262 # Remove all \\ (escaped backslashes) from the line. They are OK, and the
1263 # second (escaped) slash may trigger later \" detection erroneously.
1268 'Complex multi-line /*...*/-style comment found. '
1269 'Lint may give bogus warnings. '
1270 'Consider replacing these with //-style comments, '
1271 'with #if 0...#endif, '
1281 threading_list = (
1295 )
1299 """Checks for calls to thread-unsafe functions.
1301 Much code has been originally written without consideration of
1302 multi-threading. Also, engineers are relying on their old experience;
1303 they have learned posix before threading extensions were added. These
1304 tests guide the engineers to use thread-safe functions (when using
1305 posix directly).
1307 Args:
1308 filename: The name of the current file.
1309 clean_lines: A CleansedLines instance containing the file.
1310 linenum: The number of the line to check.
1311 error: The function to call with any errors found.
1312 """
1316 # Comparisons made explicit for clarity -- pylint: disable-msg=C6403
1325 # Matches invalid increment: *count++, which moves pointer instead of
1326 # incrementing a value.
1332 """Checks for invalid increment *count++.
1334 For example following function:
1335 void increment_counter(int* count) {
1336 *count++;
1337 }
1338 is invalid, because it effectively does count++, moving pointer, and should
1339 be replaced with ++*count, (*count)++ or *count += 1.
1341 Args:
1342 filename: The name of the current file.
1343 clean_lines: A CleansedLines instance containing the file.
1344 linenum: The number of the line to check.
1345 error: The function to call with any errors found.
1346 """
1354 """Stores information about a generic block of code."""
1362 """Run checks that applies to text up to the opening brace.
1364 This is mostly for checking the text after the class identifier
1365 and the "{", usually where the base class is specified. For other
1366 blocks, there isn't much to check, so we always pass.
1368 Args:
1369 filename: The name of the current file.
1370 clean_lines: A CleansedLines instance containing the file.
1371 linenum: The number of the line to check.
1372 error: The function to call with any errors found.
1373 """
1374 pass
1377 """Run checks that applies to text after the closing brace.
1379 This is mostly used for checking end of namespace comments.
1381 Args:
1382 filename: The name of the current file.
1383 clean_lines: A CleansedLines instance containing the file.
1384 linenum: The number of the line to check.
1385 error: The function to call with any errors found.
1386 """
1387 pass
1391 """Stores information about a class."""
1403 # Try to find the end of the class. This will be confused by things like:
1404 # class A {
1405 # } *x = { ...
1406 #
1407 # But it's still good enough for CheckSectionSpacing.
1415 break
1418 # Look for a bare ':'
1424 """Stores information about a namespace."""
1432 """Check end of namespace comments."""
1435 # Check how many lines is enclosed in this namespace. Don't issue
1436 # warning for missing namespace comments if there aren't enough
1437 # lines. However, do apply checks if there is already an end of
1438 # namespace comment and it's incorrect.
1439 #
1440 # TODO(unknown): We always want to check end of namespace comments
1441 # if a namespace is large, but sometimes we also want to apply the
1442 # check if a short namespace contained nontrivial things (something
1443 # other than forward declarations). There is currently no logic on
1444 # deciding what these nontrivial things are, so this check is
1445 # triggered by namespace size only, which works most of the time.
1448 return
1450 # Look for matching comment at end of namespace.
1451 #
1452 # Note that we accept C style "/* */" comments for terminating
1453 # namespaces, so that code that terminate namespaces inside
1454 # preprocessor macros can be cpplint clean. Example: http://go/nxpiz
1455 #
1456 # We also accept stuff like "// end of namespace <name>." with the
1457 # period at the end.
1458 #
1459 # Besides these, we don't accept anything else, otherwise we might
1460 # get false negatives when existing comment is a substring of the
1461 # expected namespace. Example: http://go/ldkdc, http://cl/23548205
1463 # Named namespace
1466 line):
1471 # Anonymous namespace
1478 """Stores checkpoints of nesting stacks when #if/#else is seen."""
1481 # The entire nesting stack before #if
1484 # The entire nesting stack up to #else
1487 # Whether we have already seen #else or #elif
1492 """Holds states related to parsing braces."""
1495 # Stack for tracking all braces. An object is pushed whenever we
1496 # see a "{", and popped when we see a "}". Only 3 types of
1497 # objects are possible:
1498 # - _ClassInfo: a class or struct.
1499 # - _NamespaceInfo: a namespace.
1500 # - _BlockInfo: some other type of block.
1503 # Stack of _PreprocessorInfo objects.
1507 """Check if we have seen the opening brace for the innermost block.
1509 Returns:
1510 True if we have seen the opening brace, False if the innermost
1511 block is still expecting an opening brace.
1512 """
1516 """Check if we are currently one level inside a namespace body.
1518 Returns:
1519 True if top of the stack is a namespace block, False otherwise.
1520 """
1524 """Update preprocessor stack.
1526 We need to handle preprocessors due to classes like this:
1527 #ifdef SWIG
1528 struct ResultDetailsPageElementExtensionPoint {
1529 #else
1530 struct ResultDetailsPageElementExtensionPoint : public Extension {
1531 #endif
1532 (see http://go/qwddn for original example)
1534 We make the following assumptions (good enough for most files):
1535 - Preprocessor condition evaluates to true from #if up to first
1536 #else/#elif/#endif.
1538 - Preprocessor condition evaluates to false from #else/#elif up
1539 to #endif. We still perform lint checks on these lines, but
1540 these do not affect nesting stack.
1542 Args:
1543 line: current line to check.
1544 """
1546 # Beginning of #if block, save the nesting stack here. The saved
1547 # stack will allow us to restore the parsing state in the #else case.
1550 # Beginning of #else block
1553 # This is the first #else or #elif block. Remember the
1554 # whole nesting stack up to this point. This is what we
1555 # keep after the #endif.
1559 # Restore the stack to how it was before the #if
1562 # TODO(unknown): unexpected #else, issue warning?
1563 pass
1565 # End of #if or #else blocks.
1567 # If we saw an #else, we will need to restore the nesting
1568 # stack to its former state before the #else, otherwise we
1569 # will just continue from where we left off.
1571 # Here we can just use a shallow copy since we are the last
1572 # reference to it.
1574 # Drop the corresponding #if
1577 # TODO(unknown): unexpected #endif, issue warning?
1578 pass
1581 """Update nesting state with current line.
1583 Args:
1584 filename: The name of the current file.
1585 clean_lines: A CleansedLines instance containing the file.
1586 linenum: The number of the line to check.
1587 error: The function to call with any errors found.
1588 """
1591 # Update pp_stack first
1594 # Count parentheses. This is to avoid adding struct arguments to
1595 # the nesting stack.
1601 # Also check if we are starting or ending an inline assembly block.
1606 # Enter assembly block
1609 # Not entering assembly block. If previous line was _END_ASM,
1610 # we will now shift to _NO_ASM state.
1614 # Exit assembly block
1617 # Consume namespace declaration at the beginning of the line. Do
1618 # this in a loop so that we catch same line declarations like this:
1619 # namespace proto2 { namespace bridge { class MessageSet; } }
1621 # Match start of namespace. The "\b\s*" below catches namespace
1622 # declarations even if it weren't followed by a whitespace, this
1623 # is so that we don't confuse our namespace checker. The
1624 # missing spaces will be flagged by CheckSpacing.
1627 break
1637 # Look for a class declaration in whatever is left of the line
1638 # after parsing namespaces. The regexp accounts for decorated classes
1639 # such as in:
1640 # class LOCKABLE API Object {
1641 # };
1642 #
1643 # Templates with class arguments may confuse the parser, for example:
1644 # template <class T
1645 # class Comparator = less<T>,
1646 # class Vector = vector<T> >
1647 # class HeapQueue {
1648 #
1649 # Because this parser has no nesting state about templates, by the
1650 # time it saw "class Comparator", it may think that it's a new class.
1651 # Nested templates have a similar problem:
1652 # template <
1653 # typename ExportedType,
1654 # typename TupleType,
1655 # template <typename, typename> class ImplTemplate>
1656 #
1657 # To avoid these cases, we ignore classes that are followed by '=' or '>'
1659 r'\s*(template\s*<[\w\s<>,:]*>\s*)?'
1660 '(class|struct)\s+([A-Z_]+\s+)*(\w+(?:::\w+)*)'
1669 # If we have not yet seen the opening brace for the innermost block,
1670 # run checks here.
1674 # Update access control if we are inside a class/struct
1680 # Consume braces or semicolons from what's left of the line
1682 # Match first brace, semicolon, or closed parenthesis.
1685 break
1689 # If namespace or class hasn't seen a opening brace yet, mark
1690 # namespace/class head as complete. Push a new block onto the
1691 # stack otherwise.
1699 # If we haven't seen an opening brace yet, but we already saw
1700 # a semicolon, this is probably a forward declaration. Pop
1701 # the stack for these.
1702 #
1703 # Similarly, if we haven't seen an opening brace yet, but we
1704 # already saw a closing parenthesis, then these are probably
1705 # function arguments with extra "class" or "struct" keywords.
1706 # Also pop these stack for these.
1710 # Perform end of block checks and pop the stack.
1717 """Get class info on the top of the stack.
1719 Returns:
1720 A _ClassInfo object if we are inside a class, or None otherwise.
1721 """
1725 return classinfo
1726 return None
1729 """Checks that all classes have been completely parsed.
1731 Call this when all lines in a file have been processed.
1732 Args:
1733 filename: The name of the current file.
1734 error: The function to call with any errors found.
1735 """
1736 # Note: This test can result in false positives if #ifdef constructs
1737 # get in the way of brace matching. See the testBuildClass test in
1738 # cpplint_unittest.py for an example of this.
1748 """Logs an error if we see certain non-ANSI constructs ignored by gcc-2.
1750 Complain about several constructs which gcc-2 accepts, but which are
1751 not standard C++. Warning about these in lint is one way to ease the
1752 transition to new compilers.
1753 - put storage class first (e.g. "static const" instead of "const static").
1754 - "%lld" instead of %qd" in printf-type functions.
1755 - "%1$d" is non-standard in printf-type functions.
1756 - "\%" is an undefined character escape sequence.
1757 - text after #endif is not allowed.
1758 - invalid inner-style forward declaration.
1759 - >? and <? operators, and their >?= and <?= cousins.
1761 Additionally, check for constructor/destructor style violations and reference
1762 members, as it is very convenient to do so while checking for
1763 gcc-2 compliance.
1765 Args:
1766 filename: The name of the current file.
1767 clean_lines: A CleansedLines instance containing the file.
1768 linenum: The number of the line to check.
1769 nesting_state: A _NestingState instance which maintains information about
1770 the current stack of nested blocks being parsed.
1771 error: A callable to which errors are reported, which takes 4 arguments:
1772 filename, line number, error level, and message
1773 """
1775 # Remove comments from the line, but leave in strings for now.
1786 # Remove escaped backslashes before looking for undefined escapes.
1793 # For the rest, work with both comments and strings removed.
1794 line = clean_lines.elided[linenum]
1800 line):
1813 line):
1818 # TODO(unknown): Could it be expanded safely to arbitrary references,
1819 # without triggering too many false positives? The first
1820 # attempt triggered 5 warnings for mostly benign code in the regtest, hence
1821 # the restriction.
1822 # Here's the original regexp, for the reference:
1823 # type_name = r'\w+((\s*::\s*\w+)|(\s*<\s*\w+?\s*>))?'
1824 # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;'
1826 'const string& members are dangerous. It is much better to use '
1829 # Everything else in this function operates on class declarations.
1830 # Return early if the top of the nesting stack is not a class, or if
1831 # the class head is not completed yet.
1834 return
1836 # The class may have been declared with namespace or classname qualifiers.
1837 # The constructor and destructor will not have those qualifiers.
1840 # Look for single-argument constructors that aren't marked explicit.
1841 # Technically a valid construct, but against style.
1844 line)
1854 """Checks for the correctness of various spacing around function calls.
1856 Args:
1857 filename: The name of the current file.
1858 line: The text of the line to check.
1859 linenum: The number of the line to check.
1860 error: The function to call with any errors found.
1861 """
1863 # Since function calls often occur inside if/for/while/switch
1864 # expressions - which have their own, more liberal conventions - we
1865 # first see if we should be looking inside such an expression for a
1866 # function call, to which we can apply more strict standards.
1875 break
1877 # Except in if/for/while/switch, there should never be space
1878 # immediately inside parens (eg "f( 3, 4 )"). We make an exception
1879 # for nested parens ( (a+b) + c ). Likewise, there should never be
1880 # a space before a ( when it's a function argument. I assume it's a
1881 # function argument when the char before the whitespace is legal in
1882 # a function name (alnum + _) and we're not starting a macro. Also ignore
1883 # pointers and references to arrays and functions coz they're too tricky:
1884 # we use a very simple way to recognize these:
1885 # " (something)(maybe-something)" or
1886 # " (something)(maybe-something," or
1887 # " (something)[something]"
1888 # Note that we assume the contents of [] to be short enough that
1889 # they'll never need to wrap.
1892 # Ignore pointers/references to functions.
1894 # Ignore pointers/references to arrays.
1907 # If the ) is followed only by a newline or a { + newline, assume it's
1908 # part of a control statement (if/while/etc), and don't complain
1910 # If the closing parenthesis is preceded by only whitespaces,
1911 # try to give a more descriptive error message.
1921 """Returns true if the given line is blank.
1923 We consider a line to be blank if the line is empty or consists of
1924 only white spaces.
1926 Args:
1927 line: A line of a string.
1929 Returns:
1930 True, if the given line is blank.
1931 """
1937 """Reports for long function bodies.
1939 For an overview why this is done, see:
1940 http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions
1942 Uses a simplistic algorithm assuming other style guidelines
1943 (especially spacing) are followed.
1944 Only checks unindented functions, so class members are unchecked.
1945 Trivial bodies are unchecked, so constructors with huge initializer lists
1946 may be missed.
1947 Blank/comment lines are not counted so as to avoid encouraging the removal
1948 of vertical space and comments just to get through a lint check.
1949 NOLINT *on the last line of a function* disables this check.
1951 Args:
1952 filename: The name of the current file.
1953 clean_lines: A CleansedLines instance containing the file.
1954 linenum: The number of the line to check.
1955 function_state: Current function name and lines in body so far.
1956 error: The function to call with any errors found.
1957 """
1968 # If the name is all caps and underscores, figure it's a macro and
1969 # ignore it, unless it's TEST or TEST_F.
1993 break
1995 # No body for the function (or evidence of a non-function) was found.
2009 """Checks for common mistakes in TODO comments.
2011 Args:
2012 comment: The text of the comment from the line in question.
2013 filename: The name of the current file.
2014 linenum: The number of the line to check.
2015 error: The function to call with any errors found.
2016 """
2019 # One whitespace is correct; zero whitespace is handled elsewhere.
2028 'Missing username in TODO; it should look like '
2032 # Comparisons made explicit for correctness -- pylint: disable-msg=C6403
2038 """Checks for improper use of DISALLOW* macros.
2040 Args:
2041 filename: The name of the current file.
2042 clean_lines: A CleansedLines instance containing the file.
2043 linenum: The number of the line to check.
2044 nesting_state: A _NestingState instance which maintains information about
2045 the current stack of nested blocks being parsed.
2046 error: The function to call with any errors found.
2047 """
2051 r'DISALLOW_EVIL_CONSTRUCTORS|'
2054 return
2061 # Found DISALLOW* macro outside a class declaration, or perhaps it
2062 # was used inside a function when it should have been part of the
2063 # class declaration. We could issue a warning here, but it
2064 # probably resulted in a compiler error already.
2065 pass
2069 """Find the corresponding > to close a template.
2071 Args:
2072 clean_lines: A CleansedLines instance containing the file.
2073 linenum: Current line number.
2074 init_suffix: Remainder of the current line after the initial <.
2076 Returns:
2077 True if a matching bracket exists.
2078 """
2079 line = init_suffix
2082 # Find the next operator that can tell us whether < is used as an
2083 # opening bracket or as a less-than operator. We only want to
2084 # warn on the latter case.
2085 #
2086 # We could also check all other operators and terminate the search
2087 # early, e.g. if we got something like this "a<b+c", the "<" is
2088 # most likely a less-than operator, but then we will get false
2089 # positives for default arguments (e.g. http://go/prccd) and
2090 # other template expressions (e.g. http://go/oxcjq).
2093 # Found an operator, update nesting stack
2098 # Expecting closing angle bracket
2104 # Found matching angle bracket
2105 return True
2107 # Got a comma after a bracket, this is most likely a template
2108 # argument. We have not seen a closing angle bracket yet, but
2109 # it's probably a few lines later if we look for it, so just
2110 # return early here.
2111 return True
2113 # Got some other operator.
2114 return False
2117 # Expecting closing parenthesis or closing bracket
2121 # We don't bother checking for matching () or []. If we got
2122 # something like (] or [), it would have been a syntax error.
2126 # Scan the next line
2129 break
2132 # Exhausted all remaining lines and still no matching angle bracket.
2133 # Most likely the input was incomplete, otherwise we should have
2134 # seen a semicolon and returned early.
2135 return True
2139 """Find the corresponding < that started a template.
2141 Args:
2142 clean_lines: A CleansedLines instance containing the file.
2143 linenum: Current line number.
2144 init_prefix: Part of the current line before the initial >.
2146 Returns:
2147 True if a matching bracket exists.
2148 """
2149 line = init_prefix
2152 # Find the previous operator
2155 # Found an operator, update nesting stack
2160 # Expecting opening angle bracket
2166 # Found matching angle bracket
2167 return True
2169 # Got a comma before a bracket, this is most likely a
2170 # template argument. The opening angle bracket is probably
2171 # there if we look for it, so just return early here.
2172 return True
2174 # Got some other operator.
2175 return False
2178 # Expecting opening parenthesis or opening bracket
2185 # Scan the previous line
2188 break
2191 # Exhausted all earlier lines and still no matching angle bracket.
2192 return False
2196 """Checks for the correctness of various spacing issues in the code.
2198 Things we check for: spaces around operators, spaces after
2199 if/for/while/switch, no spaces around parens in function calls, two
2200 spaces between code and comment, don't start a block with a blank
2201 line, don't end a function with a blank line, don't add a blank line
2202 after public/protected/private, don't have too many blank lines in a row.
2204 Args:
2205 filename: The name of the current file.
2206 clean_lines: A CleansedLines instance containing the file.
2207 linenum: The number of the line to check.
2208 nesting_state: A _NestingState instance which maintains information about
2209 the current stack of nested blocks being parsed.
2210 error: The function to call with any errors found.
2211 """
2216 # Before nixing comments, check if the line is blank for no good
2217 # reason. This includes the first line after a block is opened, and
2218 # blank lines at the end of a function (ie, right before a line like '}'
2219 #
2220 # Skip all the blank line checks if we are immediately inside a
2221 # namespace body. In other words, don't issue blank line warnings
2222 # for this block:
2223 # namespace {
2224 #
2225 # }
2226 #
2227 # A warning about missing end of namespace comments will be issued instead.
2232 # TODO(unknown): Don't complain if line before blank line, and line after,
2233 # both start with alnums and are indented the same amount.
2234 # This ignores whitespace at the start of a namespace block
2235 # because those are not usually indented.
2237 # OK, we have a blank line at the start of a code block. Before we
2238 # complain, we check if it is an exception to the rule: The previous
2239 # non-empty line has the parameters of a function header that are indented
2240 # 4 spaces (because they did not fit in a 80 column line when placed on
2241 # the same line as the function name). We also check for the case where
2242 # the previous line is indented 6 spaces, which may happen when the
2243 # initializers of a constructor do not fit into a 80 column line.
2246 # We are looking for the opening column of initializer list, which
2247 # should be indented 4 spaces to cause 6 space indentation afterwards.
2255 # Search for the function arguments or an initializer list. We use a
2256 # simple heuristic here: If the line is indented 4 spaces; and we have a
2257 # closing paren, without the opening paren, followed by an opening brace
2258 # or colon (for initializer lists) we assume that it is the last line of
2259 # a function header. If we have a colon indented 4 spaces, it is an
2260 # initializer list.
2262 prev_line)
2268 # Ignore blank lines at the end of a block in a long if-else
2269 # chain, like this:
2270 # if (condition1) {
2271 # // Something followed by a blank line
2272 #
2273 # } else if (condition2) {
2274 # // Something else
2275 # }
2289 # Next, we complain if there's a comment too near the text
2292 # Check if the // may be in quotes. If so, ignore it
2293 # Comparisons made explicit for clarity -- pylint: disable-msg=C6403
2296 # Allow one space for new scopes, two spaces otherwise:
2304 # There should always be a space between the // and the comment
2307 # but some lines are exceptions -- e.g. if they're big
2308 # comment delimiters like:
2309 # //----------------------------------------------------------
2310 # or are an empty C++ style Doxygen comment, like:
2311 # ///
2312 # or they begin with multiple slashes followed by a space:
2313 # //////// Header comment
2324 # Don't try to do spacing checks for operator methods
2327 # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )".
2328 # Otherwise not. Note we only check for non-spaces on *both* sides;
2329 # sometimes people put non-spaces on one side when aligning ='s among
2330 # many lines (not that this is behavior that I approve of...)
2335 # It's ok not to have spaces around binary operators like + - * /, but if
2336 # there's too little whitespace, we get concerned. It's hard to tell,
2337 # though, so we punt on this one for now. TODO.
2339 # You should always have whitespace around binary operators.
2340 #
2341 # Check <= and >= first to avoid false positives with < and >, then
2342 # check non-include lines for spacing around < and >.
2347 # We allow no-spaces around << when used like this: 10<<20, but
2348 # not otherwise (particularly, not when used as streams)
2354 # Avoid false positives on ->
2357 # Look for < that is not surrounded by spaces. This is only
2358 # triggered if both sides are missing spaces, even though
2359 # technically should should flag if at least one side is missing a
2360 # space. This is done to avoid some false positives with shifts.
2367 # Look for > that is not surrounded by spaces. Similar to the
2368 # above, we only trigger if both sides are missing spaces to avoid
2369 # false positives with shifts.
2377 # We allow no-spaces around >> for almost anything. This is because
2378 # C++11 allows ">>" to close nested templates, which accounts for
2379 # most cases when ">>" is not followed by a space.
2380 #
2381 # We still warn on ">>" followed by alpha character, because that is
2382 # likely due to ">>" being used for right shifts, e.g.:
2383 # value >> alpha
2384 #
2385 # When ">>" is used to close templates, the alphanumeric letter that
2386 # follows would be part of an identifier, and there should still be
2387 # a space separating the template type and the identifier.
2388 # type<type<type>> alpha
2394 # There shouldn't be space around unary operators
2400 # A pet peeve of mine: no spaces after an if, while, switch, or for
2406 # For if/for/while/switch, the left and right parens should be
2407 # consistent about how many spaces are inside the parens, and
2408 # there should either be zero or one spaces inside the parens.
2409 # We don't want: "if ( foo)" or "if ( foo )".
2410 # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed.
2413 line)
2426 # You should always have a space after a comma (either as fn arg or operator)
2431 # You should always have a space after a semicolon
2432 # except for few corner cases
2433 # TODO(unknown): clarify if 'if (1) { return 1;}' is requires one more
2434 # space after ;
2439 # Next we will look for issues with function calls.
2442 # Except after an opening paren, or after another opening brace (in case of
2443 # an initializer list, for instance), you should have spaces before your
2444 # braces. And since you should never have braces at the beginning of a line,
2445 # this is an easy test.
2450 # Make sure '} else {' has spaces.
2455 # You shouldn't have spaces before your brackets, except maybe after
2456 # 'delete []' or 'new char * []'.
2461 # You shouldn't have a space before a semicolon at the end of the line.
2462 # There's a special case for "for" since the style guide allows space before
2463 # the semicolon there.
2469 'Line contains only semicolon. If this should be an empty statement, '
2474 'Extra space before last semicolon. If this should be an empty '
2477 # In range-based for, we wanted spaces before and after the colon, but
2478 # not around "::" tokens that might appear.
2486 """Checks for additional blank line issues related to sections.
2488 Currently the only thing checked here is blank line before protected/private.
2490 Args:
2491 filename: The name of the current file.
2492 clean_lines: A CleansedLines instance containing the file.
2493 class_info: A _ClassInfo objects.
2494 linenum: The number of the line to check.
2495 error: The function to call with any errors found.
2496 """
2497 # Skip checks if the class is small, where small means 25 lines or less.
2498 # 25 lines seems like a good cutoff since that's the usual height of
2499 # terminals, and any class that can't fit in one screen can't really
2500 # be considered "small".
2501 #
2502 # Also skip checks if we are on the first line. This accounts for
2503 # classes that look like
2504 # class Foo { public: ... };
2505 #
2506 # If we didn't find the end of the class, last_line would be zero,
2507 # and the check will be skipped by the first condition.
2510 return
2514 # Issue warning if the line before public/protected/private was
2515 # not a blank line, but don't do this if the previous line contains
2516 # "class" or "struct". This can happen two ways:
2517 # - We are at the beginning of the class.
2518 # - We are forward-declaring an inner class that is semantically
2519 # private, but needed to be public for implementation reasons.
2520 # Also ignores cases where the previous line ends with a backslash as can be
2521 # common when defining classes in C macros.
2526 # Try a bit harder to find the beginning of the class. This is to
2527 # account for multi-line base-specifier lists, e.g.:
2528 # class Derived
2529 # : public Base {
2533 end_class_head = i
2534 break
2541 """Return the most recent non-blank line and its line number.
2543 Args:
2544 clean_lines: A CleansedLines instance containing the file contents.
2545 linenum: The number of the line to check.
2547 Returns:
2548 A tuple with two elements. The first element is the contents of the last
2549 non-blank line before the current line, or the empty string if this is the
2550 first non-blank line. The second is the line number of that line, or -1
2551 if this is the first non-blank line.
2552 """
2564 """Looks for misplaced braces (e.g. at the end of line).
2566 Args:
2567 filename: The name of the current file.
2568 clean_lines: A CleansedLines instance containing the file.
2569 linenum: The number of the line to check.
2570 error: The function to call with any errors found.
2571 """
2576 # We allow an open brace to start a line in the case where someone
2577 # is using braces in a block to explicitly create a new scope,
2578 # which is commonly used to control the lifetime of
2579 # stack-allocated variables. We don't detect this perfectly: we
2580 # just don't complain if the last non-whitespace character on the
2581 # previous non-blank line is ';', ':', '{', or '}', or if the previous
2582 # line starts a preprocessor block.
2589 # An else clause should be on the same line as the preceding closing brace.
2596 # If braces come on one side of an else, they should be on both.
2597 # However, we have to worry about "else if" that spans multiple lines!
2600 # find the ( after the if
2612 # Likewise, an else should never have the else clause on the same line
2617 # In the same way, a do/while should never be on one line
2622 # Braces shouldn't be followed by a ; unless they're defining a struct
2623 # or initializing an array.
2624 # We can't tell in general, but we can for some common cases.
2625 prevlinenum = linenum
2631 break
2640 """Loop for empty loop body with only a single semicolon.
2642 Args:
2643 filename: The name of the current file.
2644 clean_lines: A CleansedLines instance containing the file.
2645 linenum: The number of the line to check.
2646 error: The function to call with any errors found.
2647 """
2649 # Search for loop keywords at the beginning of the line. Because only
2650 # whitespaces are allowed before the keywords, this will also ignore most
2651 # do-while-loops, since those lines should start with closing brace.
2654 # Find the end of the conditional expression
2658 # Output warning if what follows the condition expression is a semicolon.
2659 # No warning for all other cases, including whitespace or newline, since we
2660 # have a separate check for semicolons preceded by whitespace.
2667 """Determine whether a basic CHECK can be replaced with a more specific one.
2669 For example suggest using CHECK_EQ instead of CHECK(a == b) and
2670 similarly for CHECK_GE, CHECK_GT, CHECK_LE, CHECK_LT, CHECK_NE.
2672 Args:
2673 operator: The C++ operator used in the CHECK.
2674 macro: The CHECK or EXPECT macro being called.
2675 line: The current source line.
2677 Returns:
2678 True if the CHECK can be replaced with a more specific one.
2679 """
2681 # This matches decimal and hex integers, strings, and chars (in that order).
2684 # Expression to match two sides of the operator with something that
2686 # This means we can't catch all the cases where a more specific
2687 # CHECK is possible, but it's less annoying than dealing with
2688 # extraneous warnings.
2694 # Don't complain about CHECK(x == NULL) or similar because
2695 # CHECK_EQ(x, NULL) won't compile (requires a cast).
2696 # Also, don't complain about more complex boolean expressions
2697 # involving && or || such as CHECK(a == b || c == d).
2702 """Checks the use of CHECK and EXPECT macros.
2704 Args:
2705 filename: The name of the current file.
2706 clean_lines: A CleansedLines instance containing the file.
2707 linenum: The number of the line to check.
2708 error: The function to call with any errors found.
2709 """
2711 # Decide the set of replacement macros that should be suggested
2716 current_macro = macro
2717 break
2719 # Don't waste time here if line doesn't contain 'CHECK' or 'EXPECT'
2720 return
2724 # Encourage replacing plain CHECKs with CHECK_EQ/CHECK_NE/etc.
2731 break
2735 """Check alternative keywords being used in boolean expressions.
2737 Args:
2738 filename: The name of the current file.
2739 clean_lines: A CleansedLines instance containing the file.
2740 linenum: The number of the line to check.
2741 error: The function to call with any errors found.
2742 """
2745 # Avoid preprocessor lines
2747 return
2749 # Last ditch effort to avoid multi-line comments. This will not help
2750 # if the comment started before the current line or ended after the
2751 # current line, but it catches most of the false positives. At least,
2752 # it provides a way to workaround this warning for people who use
2753 # multi-line comments in preprocessor macros.
2754 #
2755 # TODO(unknown): remove this once cpplint has better support for
2756 # multi-line comments.
2758 return
2767 """Determines the width of the line in column positions.
2769 Args:
2770 line: A string, which may be a Unicode string.
2772 Returns:
2773 The width of the line in column positions, accounting for Unicode
2774 combining characters and wide characters.
2775 """
2783 return width
2789 error):
2790 """Checks rules from the 'C++ style rules' section of cppguide.html.
2792 Most of these rules are hard to test (naming, comment style), but we
2793 do what we can. In particular we check for 2-space indents, line lengths,
2794 tab usage, spaces inside code, etc.
2796 Args:
2797 filename: The name of the current file.
2798 clean_lines: A CleansedLines instance containing the file.
2799 linenum: The number of the line to check.
2800 file_extension: The extension (without the dot) of the filename.
2801 nesting_state: A _NestingState instance which maintains information about
2802 the current stack of nested blocks being parsed.
2803 error: The function to call with any errors found.
2804 """
2813 # One or three blank spaces at the beginning of the line is weird; it's
2814 # hard to reconcile that with 2-space indents.
2815 # NOTE: here are the conditions rob pike used for his tests. Mine aren't
2816 # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces
2817 # if(RLENGTH > 20) complain = 0;
2818 # if(match($0, " +(error|private|public|protected):")) complain = 0;
2819 # if(match(prev, "&& *$")) complain = 0;
2820 # if(match(prev, "\\|\\| *$")) complain = 0;
2821 # if(match(prev, "[\",=><] *$")) complain = 0;
2822 # if(match($0, " <<")) complain = 0;
2823 # if(match(prev, " +for \\(")) complain = 0;
2824 # if(prevodd && match(prevprev, " +for \\(")) complain = 0;
2832 # There are certain situations we allow one space, notably for labels
2836 'Weird number of spaces at line-start. '
2838 # Labels should always be indented at least one space.
2840 line):
2842 'Labels should always be indented at least one space. '
2843 'If this is a member-initializer list in a constructor or '
2844 'the base class list in a class definition, the colon should '
2848 # Check if the line is a header guard.
2856 # #include lines and header guards can be long, since there's no clean way to
2857 # split them.
2858 #
2859 # URLs can be long too. It's possible to split these, but it makes them
2860 # harder to cut&paste.
2861 #
2862 # The "$Id:...$" comment may also get very long without it being the
2863 # developers fault.
2876 # for loops are allowed two ;'s (and may run over two lines).
2880 # It's ok to have many commands in a switch case that fits in 1 line
2887 # Some more style checks
2901 # Matches the first component of a filename delimited by -s and _s. That is:
2902 # _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo'
2903 # _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo'
2904 # _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo'
2905 # _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo'
2910 """Drops common suffixes like _test.cc or -inl.h from filename.
2912 For example:
2913 >>> _DropCommonSuffixes('foo/foo-inl.h')
2914 'foo/foo'
2915 >>> _DropCommonSuffixes('foo/bar/foo.cc')
2916 'foo/bar/foo'
2917 >>> _DropCommonSuffixes('foo/foo_internal.h')
2918 'foo/foo'
2919 >>> _DropCommonSuffixes('foo/foo_unusualinternal.h')
2920 'foo/foo_unusualinternal'
2922 Args:
2923 filename: The input filename.
2925 Returns:
2926 The filename with the common suffix removed.
2927 """
2937 """Determines if the given filename has a suffix that identifies it as a test.
2939 Args:
2940 filename: The input filename.
2942 Returns:
2943 True if 'filename' looks like a test, False otherwise.
2944 """
2948 return True
2950 return False
2954 """Figures out what kind of header 'include' is.
2956 Args:
2957 fileinfo: The current file cpplint is running over. A FileInfo instance.
2958 include: The path to a #included file.
2959 is_system: True if the #include used <> rather than "".
2961 Returns:
2962 One of the _XXX_HEADER constants.
2964 For example:
2965 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True)
2966 _C_SYS_HEADER
2967 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True)
2968 _CPP_SYS_HEADER
2969 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False)
2970 _LIKELY_MY_HEADER
2971 >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'),
2972 ... 'bar/foo_other_ext.h', False)
2973 _POSSIBLE_MY_HEADER
2974 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False)
2975 _OTHER_HEADER
2976 """
2977 # This is a list of all standard c++ header files, except
2978 # those already checked for above.
2984 return _CPP_SYS_HEADER
2986 return _C_SYS_HEADER
2988 # If the target file and the include we're checking share a
2989 # basename when we drop common extensions, and the include
2990 # lives in . , then it's likely to be owned by the target file.
2997 return _LIKELY_MY_HEADER
2999 # If the target and include share some initial basename
3000 # component, it's possible the target is implementing the
3001 # include, so it's allowed to be first, but we'll never
3002 # complain if it's not there.
3008 return _POSSIBLE_MY_HEADER
3010 return _OTHER_HEADER
3015 """Check rules that are applicable to #include lines.
3017 Strings on #include lines are NOT removed from elided line, to make
3018 certain tasks easier. However, to prevent false positives, checks
3019 applicable to #include lines in CheckLanguage must be put here.
3021 Args:
3022 filename: The name of the current file.
3023 clean_lines: A CleansedLines instance containing the file.
3024 linenum: The number of the line to check.
3025 include_state: An _IncludeState instance in which the headers are inserted.
3026 error: The function to call with any errors found.
3027 """
3032 # "include" should use the new style "foo/bar.h" instead of just "bar.h"
3037 # we shouldn't include a file more than once. actually, there are a
3038 # handful of instances where doing so is okay, but in general it's
3039 # not.
3051 # We want to ensure that headers appear in the right order:
3052 # 1) for foo.cc, foo.h (preferred location)
3053 # 2) c system files
3054 # 3) cpp system files
3055 # 4) for foo.cc, foo.h (deprecated location)
3056 # 5) other google headers
3057 #
3058 # We classify each include statement as one of those 5 types
3059 # using a number of techniques. The include_state object keeps
3060 # track of the highest type seen, and complains if we see a
3061 # lower type after that.
3072 # Look for any of the stream classes that are part of standard C++.
3077 # Many unit tests use cout, so we exempt them.
3084 """Retrieves all the text between matching open and close parentheses.
3086 Given a string of lines and a regular expression string, retrieve all the text
3087 following the expression and between opening punctuation symbols like
3088 (, [, or {, and the matching close-punctuation symbol. This properly nested
3089 occurrences of the punctuations, so for the text like
3090 printf(a(), b(c()));
3091 a call to _GetTextInside(text, r'printf\(') will return 'a(), b(c())'.
3092 start_pattern must match string having an open punctuation symbol at the end.
3094 Args:
3095 text: The lines to extract text. Its comments and strings must be elided.
3096 It can be single line and can span multiple lines.
3097 start_pattern: The regexp string indicating where to start extracting
3098 the text.
3099 Returns:
3100 The extracted text.
3101 None if either the opening string or ending punctuation could not be found.
3102 """
3103 # TODO(sugawarayu): Audit cpplint.py to see what places could be profitably
3104 # rewritten to use _GetTextInside (and use inferior regexp matching today).
3106 # Give opening punctuations to get the matching close-punctuations.
3110 # Find the position to start extracting text.
3113 return None
3120 # Stack of closing punctuations we expect to have in text after position.
3122 position = start_position
3127 # A closing punctuation without matching opening punctuations.
3128 return None
3133 # Opening punctuations left without matching close-punctuations.
3134 return None
3135 # punctuations match.
3140 error):
3141 """Checks rules from the 'C++ language rules' section of cppguide.html.
3143 Some of these rules are hard to test (function overloading, using
3144 uint32 inappropriately), but we do the best we can.
3146 Args:
3147 filename: The name of the current file.
3148 clean_lines: A CleansedLines instance containing the file.
3149 linenum: The number of the line to check.
3150 file_extension: The extension (without the dot) of the filename.
3151 include_state: An _IncludeState instance in which the headers are inserted.
3152 error: The function to call with any errors found.
3153 """
3154 # If the line is empty or consists of entirely a comment, no need to
3155 # check it.
3158 return
3163 return
3165 # Create an extended_line, which is the concatenation of the current and
3166 # next lines, for more effective checking of code that may span more than one
3167 # line.
3171 extended_line = line
3173 # Make Windows paths like Unix.
3176 # TODO(unknown): figure out if they're using default arguments in fn proto.
3178 # Check for non-const references in functions. This is tricky because &
3179 # is also used to take the address of something. We allow <> for templates,
3180 # (ignoring whatever is between the braces) and : for classes.
3181 # These are complicated re's. They try to capture the following:
3182 # paren (for fn-prototype start), typename, &, varname. For the const
3183 # version, we're willing for const to be before typename or after
3184 # Don't check the implementation on same line.
3190 fnline))):
3192 # We allow non-const references in a few standard places, like functions
3193 # called "swap()" or iostream operators like "<<" or ">>". We also filter
3194 # out for loops, which lint otherwise mistakenly thinks are functions.
3196 r'(for|swap|Swap|operator[<>][<>])\s*\(\s*'
3198 fnline):
3200 'Is this a non-const reference? '
3203 # Check to see if they're using an conversion function cast.
3204 # I just try to capture the most common basic types, though there are more.
3205 # Parameterless conversion functions, such as bool(), are allowed as they are
3206 # probably a member operator declaration or default constructor.
3211 # gMock methods are defined using some variant of MOCK_METHODx(name, type)
3212 # where type may be float(), int(string), etc. Without context they are
3213 # virtually indistinguishable from int(x) casts. Likewise, gMock's
3214 # MockCallback takes a template parameter of the form return_type(arg_type),
3215 # which looks much like the cast we're trying to detect.
3219 # Try a bit harder to catch gmock lines: the only place where
3220 # something looks like an old-style cast is where we declare the
3221 # return type of the mocked method, and the only time when we
3222 # are missing context is if MOCK_METHOD was split across
3223 # multiple lines (for example http://go/hrfhr ), so we only need
3224 # to check the previous line for MOCK_METHOD.
3229 'Using deprecated casting style. '
3237 # This doesn't catch all cases. Consider (const char * const)"hello".
3238 #
3239 # (char *) "foo" should always be a const_cast (reinterpret_cast won't
3240 # compile).
3243 pass
3245 # Check pointer casts for other than string constants
3249 # In addition, we look for people taking the address of a cast. This
3250 # is dangerous -- casts can assign to temporaries, so the pointer doesn't
3251 # point where you think.
3256 'This is dangerous: could be a temp var. '
3259 # Check for people declaring static/global STL strings at the top level.
3260 # This is dangerous because the C++ language does not guarantee that
3261 # globals with constructors are initialized before the first access.
3264 line)
3265 # Make sure it's not a function.
3266 # Function template specialization looks like: "string foo<Type>(...".
3267 # Class template definitions look like: "string Foo<Type>::Method(...".
3271 'For a static/global string constant, use a C style string instead: '
3275 # Check that we're not using RTTI outside of testing code.
3278 'Do not use dynamic_cast<>. If you need to cast within a class '
3279 "hierarchy, use static_cast<> to upcast. Google doesn't support "
3287 # TODO(unknown): check that 1-arg constructors are explicit.
3288 # How to tell it's a constructor?
3289 # (handled in CheckForNonStandardConstructs for now)
3290 # TODO(unknown): check that classes have DISALLOW_EVIL_CONSTRUCTORS
3291 # (level 1 error)
3292 pass
3294 # Check if people are using the verboten C basic types. The only exception
3295 # we regularly allow is "unsigned short port" for port.
3306 # When snprintf is used, the second argument shouldn't be a literal.
3309 # If 2nd arg is zero, snprintf is used to calculate size.
3314 # Check if some verboten C functions are being used.
3327 # Check if some verboten operator overloading is going on
3328 # TODO(unknown): catch out-of-line unary operator&:
3329 # class X {};
3330 # int operator&(const X& x) { return 42; } // unary operator&
3331 # The trick is it's hard to tell apart from binary operator&:
3332 # class Y { int operator&(const Y& x) { return 23; } }; // binary operator&
3337 # Check for suspicious usage of "if" like
3338 # } if (a == b) {
3343 # Check for potential format string bugs like printf(foo).
3344 # We constrain the pattern not to pick things like DocidForPrintf(foo).
3345 # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str())
3346 # TODO(sugawarayu): Catch the following case. Need to change the calling
3347 # convention of the whole function to process multiple line to handle it.
3348 # printf(
3349 # boy_this_is_a_really_long_variable_that_cannot_fit_on_the_prev_line);
3360 # Check for potential memset bugs like memset(buf, sizeof(buf), 0).
3369 'Do not use namespace using-directives. '
3372 # Detect variable-length arrays.
3376 # Split the size using space and arithmetic operators as delimiters.
3377 # If any of the resulting tokens are not compile time constants then
3378 # report the error.
3385 continue
3398 # A catch all for tricky sizeof cases, including 'sizeof expression',
3399 # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)'
3400 # requires skipping the next token because we split on ' ' and '*'.
3403 continue
3405 break
3408 'Do not use variable-length arrays. Use an appropriately named '
3411 # If DISALLOW_EVIL_CONSTRUCTORS, DISALLOW_COPY_AND_ASSIGN, or
3412 # DISALLOW_IMPLICIT_CONSTRUCTORS is present, then it should be the last thing
3413 # in the class declaration.
3416 r'(DISALLOW_(EVIL_CONSTRUCTORS|COPY_AND_ASSIGN|IMPLICIT_CONSTRUCTORS))'
3418 line)
3421 # We allow some, but not all, declarations of variables to be present
3422 # in the statement that defines the class. The [\w\*,\s]* fragment of
3423 # the regular expression below allows users to declare instances of
3424 # the class or pointers to instances, but not less common types such
3425 # as function pointers or arrays. It's a tradeoff between allowing
3426 # reasonable code and avoiding trying to parse more C++ using regexps.
3431 # Check for use of unnamed namespaces in header files. Registration
3432 # macros are typically OK, so we allow use of "namespace {" on lines
3433 # that end with backslashes.
3438 'Do not use unnamed namespaces in header files. See '
3439 'http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces'
3444 error):
3445 """Checks for a C-style cast by looking for the pattern.
3447 This also handles sizeof(type) warnings, due to similarity of content.
3449 Args:
3450 filename: The name of the current file.
3451 linenum: The number of the line to check.
3452 line: The line of code to check.
3453 raw_line: The raw line of code to check, with comments.
3454 cast_type: The string for the C++ cast to recommend. This is either
3455 reinterpret_cast, static_cast, or const_cast, depending.
3456 pattern: The regular expression used to find C-style casts.
3457 error: The function to call with any errors found.
3459 Returns:
3460 True if an error was emitted.
3461 False otherwise.
3462 """
3465 return False
3467 # e.g., sizeof(int)
3472 return True
3474 # operator++(int) and operator--(int)
3477 return False
3481 # The close paren is for function pointers as arguments to a function.
3482 # eg, void foo(void (*bar)(int));
3483 # The semicolon check is a more basic function check; also possibly a
3484 # function pointer typedef.
3485 # eg, void foo(int); or void foo(int) const;
3486 # The equals check is for function pointer assignment.
3487 # eg, void *(*foo)(int) = ...
3488 # The > is for MockCallback<...> ...
3489 #
3490 # Right now, this will only catch cases where there's a single argument, and
3491 # it's unnamed. It should probably be expanded to check for multiple
3492 # arguments with some unnamed.
3501 return True
3503 # At this point, all that should be left is actual casts.
3508 return True
3511 _HEADERS_CONTAINING_TEMPLATES = (
3529 )),
3541 # gcc extensions.
3542 # Note: std::hash is their hash, ::hash is our hash
3546 )
3550 _re_pattern_algorithm_header = []
3553 # Match max<type>(..., ...), max(..., ...), but not foo->max, foo.max or
3554 # type::max().
3557 _template,
3560 _re_pattern_templates = []
3566 _header))
3570 """Check if these two filenames belong to the same module.
3572 The concept of a 'module' here is a as follows:
3573 foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the
3574 same 'module' if they are in the same directory.
3575 some/path/public/xyzzy and some/path/internal/xyzzy are also considered
3576 to belong to the same module here.
3578 If the filename_cc contains a longer path than the filename_h, for example,
3579 '/absolute/path/to/base/sysinfo.cc', and this file would include
3580 'base/sysinfo.h', this function also produces the prefix needed to open the
3581 header. This is used by the caller of this function to more robustly open the
3582 header file. We don't have access to the real include paths in this context,
3583 so we need this guesswork here.
3585 Known bugs: tools/base/bar.cc and base/bar.h belong to the same module
3586 according to this implementation. Because of this, this function gives
3587 some false positives. This should be sufficiently rare in practice.
3589 Args:
3590 filename_cc: is the path for the .cc file
3591 filename_h: is the path for the header path
3593 Returns:
3594 Tuple with a bool and a string:
3595 bool: True if filename_cc and filename_h belong to the same module.
3596 string: the additional prefix needed to open the header file.
3597 """
3625 """Fill up the include_state with new includes found from the file.
3627 Args:
3628 filename: the name of the header to read.
3629 include_state: an _IncludeState instance in which the headers are inserted.
3630 io: The io factory to use to read the file. Provided for testability.
3632 Returns:
3633 True if a header was succesfully added. False otherwise.
3634 """
3639 return False
3647 # The value formatting is cute, but not really used right now.
3648 # What matters here is that the key is in include_state.
3650 return True
3655 """Reports for missing stl includes.
3657 This function will output warnings to make sure you are including the headers
3658 necessary for the stl containers and functions that you use. We only give one
3659 reason to include a header. For example, if you use both equal_to<> and
3660 less<> in a .h file, only one (the latter in the file) of these will be
3661 reported as a reason to include the <functional>.
3663 Args:
3664 filename: The name of the current file.
3665 clean_lines: A CleansedLines instance containing the file.
3666 include_state: An _IncludeState instance.
3667 error: The function to call with any errors found.
3668 io: The IO factory to use to read the header file. Provided for unittest
3669 injection.
3670 """
3672 # Example of required: { '<functional>': (1219, 'less<>') }
3677 continue
3679 # String is special -- it is a non-templatized type in STL.
3682 # Don't warn about strings in non-STL namespaces:
3683 # (We check only the first match per line; good enough.)
3692 # The following function is just a speed up, no semantics are changed.
3694 continue
3700 # The policy is that if you #include something in foo.h you don't need to
3701 # include it again in foo.cc. Here, we will look at possible includes.
3702 # Let's copy the include_state so it is only messed up within this function.
3705 # Did we find the header for this file (if any) and succesfully load it?
3708 # Use the absolute path so that matching works properly.
3711 # For Emacs's flymake.
3712 # If cpplint is invoked from Emacs's flymake, a temporary file is generated
3713 # by flymake and that file name might end with '_flymake.cc'. In that case,
3714 # restore original file name here so that the corresponding header file can be
3715 # found.
3716 # e.g. If the file name is 'foo_flymake.cc', we should search for 'foo.h'
3717 # instead of 'foo_flymake.h'
3720 # include_state is modified during iteration, so we iterate over a copy of
3721 # the keys.
3729 # If we can't find the header file for a .cc, assume it's because we don't
3730 # know where to look. In that case we'll give up as we're not sure they
3731 # didn't include it in the .h file.
3732 # TODO(unknown): Do a better job of finding .h files so we are confident that
3733 # not having the .h file means there isn't one.
3735 return
3737 # All the lines have been processed, report the errors found.
3750 """Check that make_pair's template arguments are deduced.
3752 G++ 4.6 in C++0x mode fails badly if make_pair's template arguments are
3753 specified explicitly, and such use isn't intended in any case.
3755 Args:
3756 filename: The name of the current file.
3757 clean_lines: A CleansedLines instance containing the file.
3758 linenum: The number of the line to check.
3759 error: The function to call with any errors found.
3760 """
3767 'For C++11-compatibility, omit template arguments from make_pair'
3773 extra_check_functions=[]):
3774 """Processes a single line in the file.
3776 Args:
3777 filename: Filename of the file that is being processed.
3778 file_extension: The extension (dot not included) of the file.
3779 clean_lines: An array of strings, each representing a line of the file,
3780 with comments stripped.
3781 line: Number of line being processed.
3782 include_state: An _IncludeState instance in which the headers are inserted.
3783 function_state: A _FunctionState instance which counts function lines, etc.
3784 nesting_state: A _NestingState instance which maintains information about
3785 the current stack of nested blocks being parsed.
3786 error: A callable to which errors are reported, which takes 4 arguments:
3787 filename, line number, error level, and message
3788 extra_check_functions: An array of additional check functions that will be
3789 run on each source line. Each function takes 4
3790 arguments: filename, clean_lines, line, error
3791 """
3796 return
3801 error)
3811 extra_check_functions=[]):
3812 """Performs lint checks and reports any errors to the given error function.
3814 Args:
3815 filename: Filename of the file that is being processed.
3816 file_extension: The extension (dot not included) of the file.
3817 lines: An array of strings, each representing a line of the file, with the
3818 last element being empty if the file is terminated with a newline.
3819 error: A callable to which errors are reported, which takes 4 arguments:
3820 filename, line number, error level, and message
3821 extra_check_functions: An array of additional check functions that will be
3822 run on each source line. Each function takes 4
3823 arguments: filename, clean_lines, line, error
3824 """
3844 extra_check_functions)
3849 # We check here rather than inside ProcessLine so that we see raw
3850 # lines rather than "cleaned" lines.
3856 """Does google-lint on a single file.
3858 Args:
3859 filename: The name of the file to parse.
3861 vlevel: The level of errors to report. Every error of confidence
3862 >= verbose_level will be reported. 0 is a good default.
3864 extra_check_functions: An array of additional check functions that will be
3865 run on each source line. Each function takes 4
3866 arguments: filename, clean_lines, line, error
3867 """
3872 # Support the UNIX convention of using "-" for stdin. Note that
3873 # we are not opening the file with universal newline support
3874 # (which codecs doesn't support anyway), so the resulting lines do
3875 # contain trailing '\r' characters if we are reading a file that
3876 # has CRLF endings.
3877 # If after the split a trailing '\r' is present, it is removed
3878 # below. If it is not expected to be present (i.e. os.linesep !=
3879 # '\r\n' as in Windows), a warning is issued below if this file
3880 # is processed.
3891 # Remove trailing '\r'.
3900 return
3902 # Note, if no dot is found, this will give the entire filename as the ext.
3905 # When reading from stdin, the extension is unknown, so no cpplint tests
3906 # should rely on the extension.
3912 extra_check_functions)
3914 # Use 0 for linenum since outputting only one error for potentially
3915 # several lines.
3924 """Prints a brief usage string and exits, optionally with an error message.
3926 Args:
3927 message: The optional error message.
3928 """
3937 """Prints a list of all the error-categories used by error messages.
3939 These are the categories used to filter messages via --filter.
3940 """
3946 """Parses the command line arguments.
3948 This may set the output format and verbosity level as side-effects.
3950 Args:
3951 args: The command line arguments:
3953 Returns:
3954 The list of filenames to lint.
3955 """
3975 output_format = val
3979 filters = val
3985 counting_style = val
3987 global _root
3988 _root = val
3998 return filenames
4004 # Change stderr to write with replacement characters so we don't die
4005 # if we try to print something containing non-ASCII characters.