| blob | 86154ededa5747e4995c3dcff7a7d61618e73cec |
1 #!/usr/bin/python2.4
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 # - Check that base classes have virtual destructors
57 # put " // namespace" after } that closes a namespace, with
58 # namespace's name after 'namespace' if it is named.
59 # - Do not indent namespace contents
60 # - Avoid inlining non-trivial constructors in header files
61 # include base/basictypes.h if DISALLOW_EVIL_CONSTRUCTORS is used
62 # - Check for old-school (void) cast for call-sites of functions
63 # ignored return value
64 # - Check gUnit usage of anonymous namespace
65 # - Check for class declaration order (typedefs, consts, enums,
66 # ctor(s?), dtor, friend declarations, methods, member vars)
67 #
69 """Does google-lint on c++ files.
71 The goal of this script is to identify places in the code that *may*
72 be in non-compliance with google style. It does not attempt to fix
73 up these problems -- the point is to educate. It does also not
74 attempt to find all problems, or to ensure that everything it does
75 find is legitimately a problem.
77 In particular, we can get very confused by /* and // inside strings!
78 We do a small hack, which is to ignore //'s with "'s after them on the
79 same line, but it is far from perfect (in either direction).
80 """
82 import codecs
83 import getopt
85 import os
86 import re
87 import sre_compile
88 import string
89 import sys
90 import unicodedata
94 Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]
95 [--counting=total|toplevel|detailed]
96 <file> [file] ...
98 The style guidelines this tries to follow are those in
99 http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
101 Every problem is given a confidence score from 1-5, with 5 meaning we are
102 certain of the problem, and 1 meaning it could be a legitimate construct.
103 This will miss some errors, and is not a substitute for a code review.
105 To suppress false-positive errors of a certain category, add a
106 'NOLINT(category)' comment to the line. NOLINT or NOLINT(*)
107 suppresses errors of all categories on that line.
109 The files passed in will be linted; at least one file must be provided.
110 Linted extensions are .cc, .cpp, and .h. Other file types will be ignored.
112 Flags:
114 output=vs7
115 By default, the output is formatted to ease emacs parsing. Visual Studio
116 compatible output (vs7) may also be used. Other formats are unsupported.
118 verbose=#
119 Specify a number 0-5 to restrict errors to certain verbosity levels.
121 filter=-x,+y,...
122 Specify a comma-separated list of category-filters to apply: only
123 error messages whose category names pass the filters will be printed.
124 (Category names are printed with the message and look like
125 "[whitespace/indent]".) Filters are evaluated left to right.
126 "-FOO" and "FOO" means "do not print categories that start with FOO".
127 "+FOO" means "do print categories that start with FOO".
129 Examples: --filter=-whitespace,+whitespace/braces
130 --filter=whitespace,runtime/printf,+runtime/printf_format
131 --filter=-,+build/include_what_you_use
133 To see a list of all the categories used in cpplint, pass no arg:
134 --filter=
136 counting=total|toplevel|detailed
137 The total number of errors found is always printed. If
138 'toplevel' is provided, then the count of errors in each of
139 the top-level categories like 'build' and 'whitespace' will
140 also be printed. If 'detailed' is provided, then a count
141 is provided for each category like 'build/class'.
142 """
144 # We categorize each error message we print. Here are the categories.
145 # We want an explicit list so we can list them all in cpplint --filter=.
146 # If you add a new error message with a new category, add it to the list
147 # here! cpplint_unittest.py should tell you if you forget to do this.
148 # \ used for clearer layout -- pylint: disable-msg=C6013
149 _ERROR_CATEGORIES = [
206 'whitespace/todo'
207 ]
209 # The default state of the category filter. This is overrided by the --filter=
210 # flag. By default all errors are on, so only add here categories that should be
211 # off by default (i.e., categories that must be enabled by the --filter= flags).
212 # All entries here should start with a '-' or '+', as in the --filter= flag.
215 # We used to check for high-bit characters, but after much discussion we
216 # decided those were OK, as long as they were in UTF-8 and didn't represent
217 # hard-coded international strings, which belong in a seperate i18n file.
219 # Headers that we consider STL headers.
227 ])
230 # Non-STL C++ system headers.
245 ])
248 # Assertion macros. These are defined in base/logging.h and
249 # testing/base/gunit.h. Note that the _M versions need to come first
250 # for substring matching to work.
251 _CHECK_MACROS = [
257 ]
259 # Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE
281 # These constants define types of headers for use with
282 # _IncludeState.CheckNextIncludeOrder().
290 _regexp_compile_cache = {}
292 # Finds occurrences of NOLINT or NOLINT(...).
295 # {str, set(int)}: a map from error categories to sets of linenumbers
296 # on which those errors are expected and should be suppressed.
297 _error_suppressions = {}
300 """Updates the global list of error-suppressions.
302 Parses any NOLINT comments on the current line, updating the global
303 error_suppressions store. Reports an error if the NOLINT comment
304 was malformed.
306 Args:
307 filename: str, the name of the input file.
308 raw_line: str, the line of input text, with comments.
309 linenum: int, the number of the current line.
310 error: function, an error handler.
311 """
312 # FIXME(adonovan): "NOLINT(" is misparsed as NOLINT(*).
329 "Resets the set of NOLINT suppressions to empty."
334 """Returns true if the specified error category is suppressed on this line.
336 Consults the global error_suppressions map populated by
337 ParseNolintSuppressions/ResetNolintSuppressions.
339 Args:
340 category: str, the category of the error.
341 linenum: int, the current line number.
342 Returns:
343 bool, True iff the error should be suppressed due to a NOLINT comment.
344 """
349 """Matches the string with the pattern, caching the compiled regexp."""
350 # The regexp compilation caching is inlined in both Match and Search for
351 # performance reasons; factoring it out into a separate function turns out
352 # to be noticeably expensive.
359 """Searches the string for the pattern, caching the compiled regexp."""
366 """Tracks line numbers for includes, and the order in which includes appear.
368 As a dict, an _IncludeState object serves as a mapping between include
369 filename and line number on which that file was included.
371 Call CheckNextIncludeOrder() once for each header in the file, passing
372 in the type constants defined above. Calls in an illegal order will
373 raise an _IncludeError with an appropriate error message.
375 """
376 # self._section will move monotonically through this set. If it ever
377 # needs to move backwards, CheckNextIncludeOrder will raise an error.
384 _TYPE_NAMES = {
390 }
391 _SECTION_NAMES = {
397 }
401 # The name of the current section.
403 # The path of last found header.
407 """Returns a path canonicalized for alphabetical comparisson.
409 - replaces "-" with "_" so they both cmp the same.
410 - removes '-inl' since we don't require them to be after the main header.
411 - lowercase everything, just in case.
413 Args:
414 header_path: Path to be canonicalized.
416 Returns:
417 Canonicalized path.
418 """
422 """Check if a header is in alphabetical order with the previous header.
424 Args:
425 header_path: Header to be checked.
427 Returns:
428 Returns true if the header is in alphabetical order.
429 """
432 return False
434 return True
437 """Returns a non-empty error message if the next header is out of order.
439 This function also updates the internal state to be ready to check
440 the next include.
442 Args:
443 header_type: One of the _XXX_HEADER constants defined above.
445 Returns:
446 The empty string if the header is in the right order, or an
447 error message describing what's wrong.
449 """
461 return error_message
467 return error_message
477 # This will always be the fallback because we're not sure
478 # enough that the header is associated with this file.
491 """Maintains module-wide state.."""
496 # filters to apply when emitting error messages
501 # output format:
502 # "emacs" - format that emacs can parse (default)
503 # "vs7" - format that Microsoft Visual Studio 7 can parse
507 """Sets the output format for errors."""
511 """Sets the module's verbosity, and returns the previous setting."""
514 return last_verbose_level
517 """Sets the module's counting options."""
521 """Sets the error-message filters.
523 These filters are applied when deciding whether to emit a given
524 error message.
526 Args:
527 filters: A string of comma-separated filters (eg "+whitespace/indent").
528 Each filter should start with + or -; else we die.
530 Raises:
531 ValueError: The comma-separated filters did not all start with '+' or '-'.
532 E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter"
533 """
534 # Default filters always have less priority than the flag ones.
546 """Sets the module's error statistic back to zero."""
551 """Bumps the module's error statistic."""
561 """Print a summary of errors by category, and the total."""
571 """Gets the module's output format."""
576 """Sets the module's output format."""
581 """Returns the module's verbosity setting."""
586 """Sets the module's verbosity, and returns the previous setting."""
591 """Sets the module's counting options."""
596 """Returns the module's list of output filters, as a list."""
601 """Sets the module's error-message filters.
603 These filters are applied when deciding whether to emit a given
604 error message.
606 Args:
607 filters: A string of comma-separated filters (eg "whitespace/indent").
608 Each filter should start with + or -; else we die.
609 """
614 """Tracks current function name and the number of lines in its body."""
625 """Start analyzing function body.
627 Args:
628 function_name: The name of the function being tracked.
629 """
635 """Count line in current function body."""
640 """Report if too many lines in function body.
642 Args:
643 error: The function to call with any errors found.
644 filename: The name of the current file.
645 linenum: The number of the line to check.
646 """
655 # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ...
659 'Small and focused functions are preferred:'
665 """Stop analizing function body."""
670 """Indicates a problem with the include order in a file."""
671 pass
675 """Provides utility functions for filenames.
677 FileInfo provides easy access to the components of a file's path
678 relative to the project root.
679 """
685 """Make Windows paths like Unix."""
689 """FullName after removing the local path to the repository.
691 If we have a real absolute path name here we can try to do something smart:
692 detecting the root of the checkout and truncating /path/to/checkout from
693 the name so that we get header guards that don't include things like
694 "C:\Documents and Settings\..." or "/home/username/..." in them and thus
695 people on different computers who have checked the source out to different
696 locations won't see bogus errors.
697 """
704 # If there's a .svn file in the current directory, we recursively look
705 # up the directory tree for the top of the SVN checkout
706 root_dir = project_dir
715 # Not SVN? Try to find a git or hg top level directory by searching up
716 # from the current path.
728 # Don't know what to do; header guard warnings may be wrong...
729 return fullname
732 """Splits the file into the directory, basename, and extension.
734 For 'chrome/browser/browser.cc', Split() would
735 return ('chrome/browser', 'browser', '.cc')
737 Returns:
738 A tuple of (directory, basename, extension).
739 """
746 """File base name - text after the final slash, before the final period."""
750 """File extension - text following the final period."""
754 """File has no source file extension."""
758 """File has a source file extension."""
763 """Returns true iff confidence >= verbose, category passes
764 filter and is not NOLINT-suppressed."""
766 # There are three ways we might decide not to print an error message:
767 # a "NOLINT(category)" comment appears in the source,
768 # the verbosity level isn't high enough, or the filters filter it out.
770 return False
772 return False
785 return False
787 return True
791 """Logs the fact we've found a lint error.
793 We log where the error was found, and also our confidence in the error,
794 that is, how certain we are this is a legitimate style regression, and
795 not a misidentification or a use that's sometimes justified.
797 False positives can be suppressed by the use of
798 "cpplint(category)" comments on the offending line. These are
799 parsed into _error_suppressions.
801 Args:
802 filename: The name of the file containing the error.
803 linenum: The number of the line containing the error.
804 category: A string used to describe the "category" this bug
805 falls under: "whitespace", say, or "runtime". Categories
806 may have a hierarchy separated by slashes: "whitespace/indent".
807 confidence: A number from 1-5 representing a confidence score for
808 the error, with 5 meaning that we are certain of the problem,
809 and 1 meaning that it could be a legitimate construct.
810 message: The error message.
811 """
822 # Matches standard C++ escape esequences per 2.13.2.3 of the C++ standard.
825 # Matches strings. Escape codes should already be removed by ESCAPES.
827 # Matches characters. Escape codes should already be removed by ESCAPES.
829 # Matches multi-line C++ comments.
830 # This RE is a little bit more complicated than one might expect, because we
831 # have to take care of space removals tools so we can handle comments inside
832 # statements better.
833 # The current rule is: We only clear spaces from both sides when we're at the
834 # end of the line. Otherwise, we try to remove spaces from the right side,
835 # if this doesn't work we try on left side but only if there's a non-character
836 # on the right.
837 _RE_PATTERN_CLEANSE_LINE_C_COMMENTS = re.compile(
838 r"""(\s*/\*.*\*/\s*$|
839 /\*.*\*/\s+|
840 \s+/\*.*\*/(?=\W)|
841 /\*.*\*/)""", re.VERBOSE)
844 def IsCppString(line):
845 """Does line terminate so, that the next symbol is in string constant.
847 This function does not consider single-line nor multi-line comments.
849 Args:
850 line: is a partial line of code starting from the 0..n.
852 Returns:
853 True, if next character appended to 'line' is inside a
854 string constant.
855 """
862 """Find the beginning marker for a multiline comment."""
865 # Only return this marker if the comment goes beyond this line
867 return lineix
873 """We are inside a comment, find the end marker."""
876 return lineix
882 """Clears a range of lines for multi-line comments."""
883 # Having // dummy comments makes the lines non-empty, so we will not get
884 # unnecessary blank line warnings later in the code.
890 """Removes multiline (c-style) comments from lines."""
895 return
900 return
906 """Removes //-comments and single-line C-style /* */ comments.
908 Args:
909 line: A line of C++ source.
911 Returns:
912 The line with single-line comments removed.
913 """
917 # get rid of /* ... */
922 """Holds 3 copies of all lines with different preprocessing applied to them.
924 1) elided member contains lines without strings and comments,
925 2) lines member contains lines without comments, and
926 3) raw member contains all the lines without processing.
927 All these three members are of <type 'list'>, and of the same length.
928 """
941 """Returns the number of lines represented."""
944 @staticmethod
946 """Collapses strings and chars on a line to simple "" or '' blocks.
948 We nix strings first so we're not fooled by text like '"http://"'
950 Args:
951 elided: The line being processed.
953 Returns:
954 The line with collapsed strings.
955 """
957 # Remove escaped characters first to make quote/single quote collapsing
958 # basic. Things that look like escaped characters shouldn't occur
959 # outside of strings and chars.
963 return elided
967 """If input points to ( or { or [, finds the position that closes it.
969 If lines[linenum][pos] points to a '(' or '{' or '[', finds the the
970 linenum/pos that correspond to the closing of the expression.
972 Args:
973 clean_lines: A CleansedLines instance containing the file.
974 linenum: The number of the line to check.
975 pos: A position on the line.
977 Returns:
978 A tuple (line, linenum, pos) pointer *past* the closing brace, or
979 (line, len(lines), -1) if we never find a close. Note we ignore
980 strings and comments when matching; and the line we return is the
981 'cleansed' line at linenum.
982 """
997 # OK, now find the endchar that actually got us back to even
1006 """Logs an error if no Copyright message appears at the top of the file."""
1008 # We'll say it should occur by line 10. Don't forget there's a
1009 # dummy line at the front.
1014 'No copyright message found. '
1019 """Returns the CPP variable that should be used as a header guard.
1021 Args:
1022 filename: The name of a C++ header file.
1024 Returns:
1025 The CPP variable that should be used as a header guard in the
1026 named file.
1028 """
1030 # Restores original filename in case that cpplint is invoked from Emacs's
1031 # flymake.
1039 """Checks that the file contains a header guard.
1041 Logs an error if no #ifndef header guard is present. For other
1042 headers, checks that the full pathname is used.
1044 Args:
1045 filename: The name of the C++ header file.
1046 lines: An array of strings, each representing a line of the file.
1047 error: The function to call with any errors found.
1048 """
1060 # find the first occurrence of #ifndef and #define, save arg
1062 # set ifndef to the header guard presented on the #ifndef line.
1064 ifndef_linenum = linenum
1067 # find the last occurrence of #endif, save entire line
1069 endif = line
1070 endif_linenum = linenum
1075 cppvar)
1076 return
1078 # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__
1079 # for backward compatibility.
1086 error)
1096 error)
1102 """Logs an error for each line containing Unicode replacement characters.
1104 These indicate that either the file contained invalid UTF-8 (likely)
1105 or Unicode replacement characters (which it shouldn't). Note that
1106 it's possible for this to throw off line numbering if the invalid
1107 UTF-8 occurred adjacent to a newline.
1109 Args:
1110 filename: The name of the current file.
1111 lines: An array of strings, each representing a line of the file.
1112 error: The function to call with any errors found.
1113 """
1121 """Logs an error if there is no newline char at the end of the file.
1123 Args:
1124 filename: The name of the current file.
1125 lines: An array of strings, each representing a line of the file.
1126 error: The function to call with any errors found.
1127 """
1129 # The array lines() was created by adding two newlines to the
1130 # original file (go figure), then splitting on \n.
1131 # To verify that the file ends in \n, we just have to make sure the
1132 # last-but-two element of lines() exists and is empty.
1139 """Logs an error if we see /* ... */ or "..." that extend past one line.
1141 /* ... */ comments are legit inside macros, for one line.
1142 Otherwise, we prefer // comments, so it's ok to warn about the
1143 other. Likewise, it's ok for strings to extend across multiple
1144 lines, as long as a line continuation character (backslash)
1145 terminates each line. Although not currently prohibited by the C++
1146 style guide, it's ugly and unnecessary. We don't do well with either
1147 in this lint program, so we warn about both.
1149 Args:
1150 filename: The name of the current file.
1151 clean_lines: A CleansedLines instance containing the file.
1152 linenum: The number of the line to check.
1153 error: The function to call with any errors found.
1154 """
1157 # Remove all \\ (escaped backslashes) from the line. They are OK, and the
1158 # second (escaped) slash may trigger later \" detection erroneously.
1163 'Complex multi-line /*...*/-style comment found. '
1164 'Lint may give bogus warnings. '
1165 'Consider replacing these with //-style comments, '
1166 'with #if 0...#endif, '
1176 threading_list = (
1190 )
1194 """Checks for calls to thread-unsafe functions.
1196 Much code has been originally written without consideration of
1197 multi-threading. Also, engineers are relying on their old experience;
1198 they have learned posix before threading extensions were added. These
1199 tests guide the engineers to use thread-safe functions (when using
1200 posix directly).
1202 Args:
1203 filename: The name of the current file.
1204 clean_lines: A CleansedLines instance containing the file.
1205 linenum: The number of the line to check.
1206 error: The function to call with any errors found.
1207 """
1211 # Comparisons made explicit for clarity -- pylint: disable-msg=C6403
1220 # Matches invalid increment: *count++, which moves pointer instead of
1221 # incrementing a value.
1227 """Checks for invalid increment *count++.
1229 For example following function:
1230 void increment_counter(int* count) {
1231 *count++;
1232 }
1233 is invalid, because it effectively does count++, moving pointer, and should
1234 be replaced with ++*count, (*count)++ or *count += 1.
1236 Args:
1237 filename: The name of the current file.
1238 clean_lines: A CleansedLines instance containing the file.
1239 linenum: The number of the line to check.
1240 error: The function to call with any errors found.
1241 """
1249 """Stores information about a class."""
1262 """Holds the current state of the parse relating to class declarations.
1264 It maintains a stack of _ClassInfos representing the parser's guess
1265 as to the current nesting of class declarations. The innermost class
1266 is at the top (back) of the stack. Typically, the stack will either
1267 be empty or have exactly one entry.
1268 """
1274 """Checks that all classes have been completely parsed.
1276 Call this when all lines in a file have been processed.
1277 Args:
1278 filename: The name of the current file.
1279 error: The function to call with any errors found.
1280 """
1282 # Note: This test can result in false positives if #ifdef constructs
1283 # get in the way of brace matching. See the testBuildClass test in
1284 # cpplint_unittest.py for an example of this.
1292 """Logs an error if we see certain non-ANSI constructs ignored by gcc-2.
1294 Complain about several constructs which gcc-2 accepts, but which are
1295 not standard C++. Warning about these in lint is one way to ease the
1296 transition to new compilers.
1297 - put storage class first (e.g. "static const" instead of "const static").
1298 - "%lld" instead of %qd" in printf-type functions.
1299 - "%1$d" is non-standard in printf-type functions.
1300 - "\%" is an undefined character escape sequence.
1301 - text after #endif is not allowed.
1302 - invalid inner-style forward declaration.
1303 - >? and <? operators, and their >?= and <?= cousins.
1304 - classes with virtual methods need virtual destructors (compiler warning
1305 available, but not turned on yet.)
1307 Additionally, check for constructor/destructor style violations and reference
1308 members, as it is very convenient to do so while checking for
1309 gcc-2 compliance.
1311 Args:
1312 filename: The name of the current file.
1313 clean_lines: A CleansedLines instance containing the file.
1314 linenum: The number of the line to check.
1315 class_state: A _ClassState instance which maintains information about
1316 the current stack of nested class declarations being parsed.
1317 error: A callable to which errors are reported, which takes 4 arguments:
1318 filename, line number, error level, and message
1319 """
1321 # Remove comments from the line, but leave in strings for now.
1332 # Remove escaped backslashes before looking for undefined escapes.
1339 # For the rest, work with both comments and strings removed.
1340 line = clean_lines.elided[linenum]
1346 line):
1359 line):
1364 # TODO(unknown): Could it be expanded safely to arbitrary references,
1365 # without triggering too many false positives? The first
1366 # attempt triggered 5 warnings for mostly benign code in the regtest, hence
1367 # the restriction.
1368 # Here's the original regexp, for the reference:
1369 # type_name = r'\w+((\s*::\s*\w+)|(\s*<\s*\w+?\s*>))?'
1370 # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;'
1372 'const string& members are dangerous. It is much better to use '
1375 # Track class entry and exit, and attempt to find cases within the
1376 # class declaration that don't meet the C++ style
1377 # guidelines. Tracking is very dependent on the code matching Google
1378 # style guidelines, but it seems to perform well enough in testing
1379 # to be a worthwhile addition to the checks.
1381 # Look for a class declaration
1387 # Everything else in this function uses the top of the stack if it's
1388 # not empty.
1390 return
1394 # If the opening brace hasn't been seen look for it and also
1395 # parent class declarations.
1397 # If the line has a ';' in it, assume it's a forward declaration or
1398 # a single-line class declaration, which we won't process.
1401 return
1403 # Look for a bare ':'
1409 # The class may have been declared with namespace or classname qualifiers.
1410 # The constructor and destructor will not have those qualifiers.
1413 # Look for single-argument constructors that aren't marked explicit.
1414 # Technically a valid construct, but against style.
1417 line)
1425 # Look for methods declared virtual.
1428 # Only look for a destructor declaration on the same line. It would
1429 # be extremely unlikely for the destructor declaration to occupy
1430 # more than one line.
1434 # Look for class end.
1439 # Try to detect missing virtual destructor declarations.
1440 # For now, only warn if a non-derived class with virtual methods lacks
1441 # a virtual destructor. This is to make it less likely that people will
1442 # declare derived virtual destructors without declaring the base
1443 # destructor virtual.
1456 """Checks for the correctness of various spacing around function calls.
1458 Args:
1459 filename: The name of the current file.
1460 line: The text of the line to check.
1461 linenum: The number of the line to check.
1462 error: The function to call with any errors found.
1463 """
1465 # Since function calls often occur inside if/for/while/switch
1466 # expressions - which have their own, more liberal conventions - we
1467 # first see if we should be looking inside such an expression for a
1468 # function call, to which we can apply more strict standards.
1477 break
1479 # Except in if/for/while/switch, there should never be space
1480 # immediately inside parens (eg "f( 3, 4 )"). We make an exception
1481 # for nested parens ( (a+b) + c ). Likewise, there should never be
1482 # a space before a ( when it's a function argument. I assume it's a
1483 # function argument when the char before the whitespace is legal in
1484 # a function name (alnum + _) and we're not starting a macro. Also ignore
1485 # pointers and references to arrays and functions coz they're too tricky:
1486 # we use a very simple way to recognize these:
1487 # " (something)(maybe-something)" or
1488 # " (something)(maybe-something," or
1489 # " (something)[something]"
1490 # Note that we assume the contents of [] to be short enough that
1491 # they'll never need to wrap.
1494 # Ignore pointers/references to functions.
1496 # Ignore pointers/references to arrays.
1508 # If the ) is followed only by a newline or a { + newline, assume it's
1509 # part of a control statement (if/while/etc), and don't complain
1516 """Returns true if the given line is blank.
1518 We consider a line to be blank if the line is empty or consists of
1519 only white spaces.
1521 Args:
1522 line: A line of a string.
1524 Returns:
1525 True, if the given line is blank.
1526 """
1532 """Reports for long function bodies.
1534 For an overview why this is done, see:
1535 http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions
1537 Uses a simplistic algorithm assuming other style guidelines
1538 (especially spacing) are followed.
1539 Only checks unindented functions, so class members are unchecked.
1540 Trivial bodies are unchecked, so constructors with huge initializer lists
1541 may be missed.
1542 Blank/comment lines are not counted so as to avoid encouraging the removal
1543 of vertical space and commments just to get through a lint check.
1544 NOLINT *on the last line of a function* disables this check.
1546 Args:
1547 filename: The name of the current file.
1548 clean_lines: A CleansedLines instance containing the file.
1549 linenum: The number of the line to check.
1550 function_state: Current function name and lines in body so far.
1551 error: The function to call with any errors found.
1552 """
1563 # If the name is all caps and underscores, figure it's a macro and
1564 # ignore it, unless it's TEST or TEST_F.
1588 break
1590 # No body for the function (or evidence of a non-function) was found.
1604 """Checks for common mistakes in TODO comments.
1606 Args:
1607 comment: The text of the comment from the line in question.
1608 filename: The name of the current file.
1609 linenum: The number of the line to check.
1610 error: The function to call with any errors found.
1611 """
1614 # One whitespace is correct; zero whitespace is handled elsewhere.
1623 'Missing username in TODO; it should look like '
1627 # Comparisons made explicit for correctness -- pylint: disable-msg=C6403
1634 """Checks for the correctness of various spacing issues in the code.
1636 Things we check for: spaces around operators, spaces after
1637 if/for/while/switch, no spaces around parens in function calls, two
1638 spaces between code and comment, don't start a block with a blank
1639 line, don't end a function with a blank line, don't have too many
1640 blank lines in a row.
1642 Args:
1643 filename: The name of the current file.
1644 clean_lines: A CleansedLines instance containing the file.
1645 linenum: The number of the line to check.
1646 error: The function to call with any errors found.
1647 """
1652 # Before nixing comments, check if the line is blank for no good
1653 # reason. This includes the first line after a block is opened, and
1654 # blank lines at the end of a function (ie, right before a line like '}'
1659 # TODO(unknown): Don't complain if line before blank line, and line after,
1660 # both start with alnums and are indented the same amount.
1661 # This ignores whitespace at the start of a namespace block
1662 # because those are not usually indented.
1665 # OK, we have a blank line at the start of a code block. Before we
1666 # complain, we check if it is an exception to the rule: The previous
1667 # non-empty line has the paramters of a function header that are indented
1668 # 4 spaces (because they did not fit in a 80 column line when placed on
1669 # the same line as the function name). We also check for the case where
1670 # the previous line is indented 6 spaces, which may happen when the
1671 # initializers of a constructor do not fit into a 80 column line.
1674 # We are looking for the opening column of initializer list, which
1675 # should be indented 4 spaces to cause 6 space indentation afterwards.
1683 # Search for the function arguments or an initializer list. We use a
1684 # simple heuristic here: If the line is indented 4 spaces; and we have a
1685 # closing paren, without the opening paren, followed by an opening brace
1686 # or colon (for initializer lists) we assume that it is the last line of
1687 # a function header. If we have a colon indented 4 spaces, it is an
1688 # initializer list.
1690 prev_line)
1696 # This doesn't ignore whitespace at the end of a namespace block
1697 # because that is too hard without pairing open/close braces;
1698 # however, a special exception is made for namespace closing
1699 # brackets which have a comment containing "namespace".
1700 #
1701 # Also, ignore blank lines at the end of a block in a long if-else
1702 # chain, like this:
1703 # if (condition1) {
1704 # // Something followed by a blank line
1705 #
1706 # } else if (condition2) {
1707 # // Something else
1708 # }
1718 # Next, we complain if there's a comment too near the text
1721 # Check if the // may be in quotes. If so, ignore it
1722 # Comparisons made explicit for clarity -- pylint: disable-msg=C6403
1725 # Allow one space for new scopes, two spaces otherwise:
1733 # There should always be a space between the // and the comment
1736 # but some lines are exceptions -- e.g. if they're big
1737 # comment delimiters like:
1738 # //----------------------------------------------------------
1739 # or are an empty C++ style Doxygen comment, like:
1740 # ///
1741 # or they begin with multiple slashes followed by a space:
1742 # //////// Header comment
1753 # Don't try to do spacing checks for operator methods
1756 # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )".
1757 # Otherwise not. Note we only check for non-spaces on *both* sides;
1758 # sometimes people put non-spaces on one side when aligning ='s among
1759 # many lines (not that this is behavior that I approve of...)
1764 # It's ok not to have spaces around binary operators like + - * /, but if
1765 # there's too little whitespace, we get concerned. It's hard to tell,
1766 # though, so we punt on this one for now. TODO.
1768 # You should always have whitespace around binary operators.
1769 # Alas, we can't test < or > because they're legitimately used sans spaces
1770 # (a->b, vector<int> a). The only time we can tell is a < with no >, and
1771 # only if it's not template params list spilling into the next line.
1774 # Note that while it seems that the '<[^<]*' term in the following
1775 # regexp could be simplified to '<.*', which would indeed match
1776 # the same class of strings, the [^<] means that searching for the
1777 # regexp takes linear rather than quadratic time.
1783 # We allow no-spaces around << and >> when used like this: 10<<20, but
1784 # not otherwise (particularly, not when used as streams)
1790 # There shouldn't be space around unary operators
1796 # A pet peeve of mine: no spaces after an if, while, switch, or for
1802 # For if/for/while/switch, the left and right parens should be
1803 # consistent about how many spaces are inside the parens, and
1804 # there should either be zero or one spaces inside the parens.
1805 # We don't want: "if ( foo)" or "if ( foo )".
1806 # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed.
1809 line)
1822 # You should always have a space after a comma (either as fn arg or operator)
1827 # Next we will look for issues with function calls.
1830 # Except after an opening paren, you should have spaces before your braces.
1831 # And since you should never have braces at the beginning of a line, this is
1832 # an easy test.
1837 # Make sure '} else {' has spaces.
1842 # You shouldn't have spaces before your brackets, except maybe after
1843 # 'delete []' or 'new char * []'.
1848 # You shouldn't have a space before a semicolon at the end of the line.
1849 # There's a special case for "for" since the style guide allows space before
1850 # the semicolon there.
1856 'Line contains only semicolon. If this should be an empty statement, '
1861 'Extra space before last semicolon. If this should be an empty '
1866 """Return the most recent non-blank line and its line number.
1868 Args:
1869 clean_lines: A CleansedLines instance containing the file contents.
1870 linenum: The number of the line to check.
1872 Returns:
1873 A tuple with two elements. The first element is the contents of the last
1874 non-blank line before the current line, or the empty string if this is the
1875 first non-blank line. The second is the line number of that line, or -1
1876 if this is the first non-blank line.
1877 """
1889 """Looks for misplaced braces (e.g. at the end of line).
1891 Args:
1892 filename: The name of the current file.
1893 clean_lines: A CleansedLines instance containing the file.
1894 linenum: The number of the line to check.
1895 error: The function to call with any errors found.
1896 """
1901 # We allow an open brace to start a line in the case where someone
1902 # is using braces in a block to explicitly create a new scope,
1903 # which is commonly used to control the lifetime of
1904 # stack-allocated variables. We don't detect this perfectly: we
1905 # just don't complain if the last non-whitespace character on the
1906 # previous non-blank line is ';', ':', '{', or '}'.
1912 # An else clause should be on the same line as the preceding closing brace.
1919 # If braces come on one side of an else, they should be on both.
1920 # However, we have to worry about "else if" that spans multiple lines!
1923 # find the ( after the if
1935 # Likewise, an else should never have the else clause on the same line
1940 # In the same way, a do/while should never be on one line
1945 # Braces shouldn't be followed by a ; unless they're defining a struct
1946 # or initializing an array.
1947 # We can't tell in general, but we can for some common cases.
1948 prevlinenum = linenum
1954 break
1963 """Determine whether a basic CHECK can be replaced with a more specific one.
1965 For example suggest using CHECK_EQ instead of CHECK(a == b) and
1966 similarly for CHECK_GE, CHECK_GT, CHECK_LE, CHECK_LT, CHECK_NE.
1968 Args:
1969 operator: The C++ operator used in the CHECK.
1970 macro: The CHECK or EXPECT macro being called.
1971 line: The current source line.
1973 Returns:
1974 True if the CHECK can be replaced with a more specific one.
1975 """
1977 # This matches decimal and hex integers, strings, and chars (in that order).
1980 # Expression to match two sides of the operator with something that
1982 # This means we can't catch all the cases where a more specific
1983 # CHECK is possible, but it's less annoying than dealing with
1984 # extraneous warnings.
1990 # Don't complain about CHECK(x == NULL) or similar because
1991 # CHECK_EQ(x, NULL) won't compile (requires a cast).
1992 # Also, don't complain about more complex boolean expressions
1993 # involving && or || such as CHECK(a == b || c == d).
1998 """Checks the use of CHECK and EXPECT macros.
2000 Args:
2001 filename: The name of the current file.
2002 clean_lines: A CleansedLines instance containing the file.
2003 linenum: The number of the line to check.
2004 error: The function to call with any errors found.
2005 """
2007 # Decide the set of replacement macros that should be suggested
2012 current_macro = macro
2013 break
2015 # Don't waste time here if line doesn't contain 'CHECK' or 'EXPECT'
2016 return
2020 # Encourage replacing plain CHECKs with CHECK_EQ/CHECK_NE/etc.
2027 break
2031 """Determines the width of the line in column positions.
2033 Args:
2034 line: A string, which may be a Unicode string.
2036 Returns:
2037 The width of the line in column positions, accounting for Unicode
2038 combining characters and wide characters.
2039 """
2047 return width
2053 """Checks rules from the 'C++ style rules' section of cppguide.html.
2055 Most of these rules are hard to test (naming, comment style), but we
2056 do what we can. In particular we check for 2-space indents, line lengths,
2057 tab usage, spaces inside code, etc.
2059 Args:
2060 filename: The name of the current file.
2061 clean_lines: A CleansedLines instance containing the file.
2062 linenum: The number of the line to check.
2063 file_extension: The extension (without the dot) of the filename.
2064 error: The function to call with any errors found.
2065 """
2074 # One or three blank spaces at the beginning of the line is weird; it's
2075 # hard to reconcile that with 2-space indents.
2076 # NOTE: here are the conditions rob pike used for his tests. Mine aren't
2077 # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces
2078 # if(RLENGTH > 20) complain = 0;
2079 # if(match($0, " +(error|private|public|protected):")) complain = 0;
2080 # if(match(prev, "&& *$")) complain = 0;
2081 # if(match(prev, "\\|\\| *$")) complain = 0;
2082 # if(match(prev, "[\",=><] *$")) complain = 0;
2083 # if(match($0, " <<")) complain = 0;
2084 # if(match(prev, " +for \\(")) complain = 0;
2085 # if(prevodd && match(prevprev, " +for \\(")) complain = 0;
2093 # There are certain situations we allow one space, notably for labels
2097 'Weird number of spaces at line-start. '
2099 # Labels should always be indented at least one space.
2101 line):
2103 'Labels should always be indented at least one space. '
2104 'If this is a member-initializer list in a constructor or '
2105 'the base class list in a class definition, the colon should '
2109 # Check if the line is a header guard.
2117 # #include lines and header guards can be long, since there's no clean way to
2118 # split them.
2119 #
2120 # URLs can be long too. It's possible to split these, but it makes them
2121 # harder to cut&paste.
2133 # for loops are allowed two ;'s (and may run over two lines).
2137 # It's ok to have many commands in a switch case that fits in 1 line
2144 # Some more style checks
2152 # Matches the first component of a filename delimited by -s and _s. That is:
2153 # _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo'
2154 # _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo'
2155 # _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo'
2156 # _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo'
2161 """Drops common suffixes like _test.cc or -inl.h from filename.
2163 For example:
2164 >>> _DropCommonSuffixes('foo/foo-inl.h')
2165 'foo/foo'
2166 >>> _DropCommonSuffixes('foo/bar/foo.cc')
2167 'foo/bar/foo'
2168 >>> _DropCommonSuffixes('foo/foo_internal.h')
2169 'foo/foo'
2170 >>> _DropCommonSuffixes('foo/foo_unusualinternal.h')
2171 'foo/foo_unusualinternal'
2173 Args:
2174 filename: The input filename.
2176 Returns:
2177 The filename with the common suffix removed.
2178 """
2188 """Determines if the given filename has a suffix that identifies it as a test.
2190 Args:
2191 filename: The input filename.
2193 Returns:
2194 True if 'filename' looks like a test, False otherwise.
2195 """
2199 return True
2201 return False
2205 """Figures out what kind of header 'include' is.
2207 Args:
2208 fileinfo: The current file cpplint is running over. A FileInfo instance.
2209 include: The path to a #included file.
2210 is_system: True if the #include used <> rather than "".
2212 Returns:
2213 One of the _XXX_HEADER constants.
2215 For example:
2216 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True)
2217 _C_SYS_HEADER
2218 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True)
2219 _CPP_SYS_HEADER
2220 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False)
2221 _LIKELY_MY_HEADER
2222 >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'),
2223 ... 'bar/foo_other_ext.h', False)
2224 _POSSIBLE_MY_HEADER
2225 >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False)
2226 _OTHER_HEADER
2227 """
2228 # This is a list of all standard c++ header files, except
2229 # those already checked for above.
2235 return _CPP_SYS_HEADER
2237 return _C_SYS_HEADER
2239 # If the target file and the include we're checking share a
2240 # basename when we drop common extensions, and the include
2241 # lives in . , then it's likely to be owned by the target file.
2248 return _LIKELY_MY_HEADER
2250 # If the target and include share some initial basename
2251 # component, it's possible the target is implementing the
2252 # include, so it's allowed to be first, but we'll never
2253 # complain if it's not there.
2259 return _POSSIBLE_MY_HEADER
2261 return _OTHER_HEADER
2266 """Check rules that are applicable to #include lines.
2268 Strings on #include lines are NOT removed from elided line, to make
2269 certain tasks easier. However, to prevent false positives, checks
2270 applicable to #include lines in CheckLanguage must be put here.
2272 Args:
2273 filename: The name of the current file.
2274 clean_lines: A CleansedLines instance containing the file.
2275 linenum: The number of the line to check.
2276 include_state: An _IncludeState instance in which the headers are inserted.
2277 error: The function to call with any errors found.
2278 """
2283 # "include" should use the new style "foo/bar.h" instead of just "bar.h"
2288 # we shouldn't include a file more than once. actually, there are a
2289 # handful of instances where doing so is okay, but in general it's
2290 # not.
2302 # We want to ensure that headers appear in the right order:
2303 # 1) for foo.cc, foo.h (preferred location)
2304 # 2) c system files
2305 # 3) cpp system files
2306 # 4) for foo.cc, foo.h (deprecated location)
2307 # 5) other google headers
2308 #
2309 # We classify each include statement as one of those 5 types
2310 # using a number of techniques. The include_state object keeps
2311 # track of the highest type seen, and complains if we see a
2312 # lower type after that.
2323 # Look for any of the stream classes that are part of standard C++.
2328 # Many unit tests use cout, so we exempt them.
2334 error):
2335 """Checks rules from the 'C++ language rules' section of cppguide.html.
2337 Some of these rules are hard to test (function overloading, using
2338 uint32 inappropriately), but we do the best we can.
2340 Args:
2341 filename: The name of the current file.
2342 clean_lines: A CleansedLines instance containing the file.
2343 linenum: The number of the line to check.
2344 file_extension: The extension (without the dot) of the filename.
2345 include_state: An _IncludeState instance in which the headers are inserted.
2346 error: The function to call with any errors found.
2347 """
2348 # If the line is empty or consists of entirely a comment, no need to
2349 # check it.
2352 return
2357 return
2359 # Create an extended_line, which is the concatenation of the current and
2360 # next lines, for more effective checking of code that may span more than one
2361 # line.
2365 extended_line = line
2367 # Make Windows paths like Unix.
2370 # TODO(unknown): figure out if they're using default arguments in fn proto.
2372 # Check for non-const references in functions. This is tricky because &
2373 # is also used to take the address of something. We allow <> for templates,
2374 # (ignoring whatever is between the braces) and : for classes.
2375 # These are complicated re's. They try to capture the following:
2376 # paren (for fn-prototype start), typename, &, varname. For the const
2377 # version, we're willing for const to be before typename or after
2378 # Don't check the implemention on same line.
2384 fnline))):
2386 # We allow non-const references in a few standard places, like functions
2387 # called "swap()" or iostream operators like "<<" or ">>".
2390 fnline):
2392 'Is this a non-const reference? '
2395 # Check to see if they're using an conversion function cast.
2396 # I just try to capture the most common basic types, though there are more.
2397 # Parameterless conversion functions, such as bool(), are allowed as they are
2398 # probably a member operator declaration or default constructor.
2403 # gMock methods are defined using some variant of MOCK_METHODx(name, type)
2404 # where type may be float(), int(string), etc. Without context they are
2405 # virtually indistinguishable from int(x) casts.
2409 'Using deprecated casting style. '
2416 error)
2417 # This doesn't catch all cases. Consider (const char * const)"hello".
2421 # In addition, we look for people taking the address of a cast. This
2422 # is dangerous -- casts can assign to temporaries, so the pointer doesn't
2423 # point where you think.
2428 'This is dangerous: could be a temp var. '
2431 # Check for people declaring static/global STL strings at the top level.
2432 # This is dangerous because the C++ language does not guarantee that
2433 # globals with constructors are initialized before the first access.
2436 line)
2437 # Make sure it's not a function.
2438 # Function template specialization looks like: "string foo<Type>(...".
2439 # Class template definitions look like: "string Foo<Type>::Method(...".
2443 'For a static/global string constant, use a C style string instead: '
2447 # Check that we're not using RTTI outside of testing code.
2450 'Do not use dynamic_cast<>. If you need to cast within a class '
2451 "hierarchy, use static_cast<> to upcast. Google doesn't support "
2459 # TODO(unknown): check that 1-arg constructors are explicit.
2460 # How to tell it's a constructor?
2461 # (handled in CheckForNonStandardConstructs for now)
2462 # TODO(unknown): check that classes have DISALLOW_EVIL_CONSTRUCTORS
2463 # (level 1 error)
2464 pass
2466 # Check if people are using the verboten C basic types. The only exception
2467 # we regularly allow is "unsigned short port" for port.
2478 # When snprintf is used, the second argument shouldn't be a literal.
2481 # If 2nd arg is zero, snprintf is used to calculate size.
2486 # Check if some verboten C functions are being used.
2499 # Check if some verboten operator overloading is going on
2500 # TODO(unknown): catch out-of-line unary operator&:
2501 # class X {};
2502 # int operator&(const X& x) { return 42; } // unary operator&
2503 # The trick is it's hard to tell apart from binary operator&:
2504 # class Y { int operator&(const Y& x) { return 23; } }; // binary operator&
2509 # Check for suspicious usage of "if" like
2510 # } if (a == b) {
2515 # Check for potential format string bugs like printf(foo).
2516 # We constrain the pattern not to pick things like DocidForPrintf(foo).
2517 # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str())
2524 # Check for potential memset bugs like memset(buf, sizeof(buf), 0).
2533 'Do not use namespace using-directives. '
2536 # Detect variable-length arrays.
2540 # Split the size using space and arithmetic operators as delimiters.
2541 # If any of the resulting tokens are not compile time constants then
2542 # report the error.
2549 continue
2562 # A catch all for tricky sizeof cases, including 'sizeof expression',
2563 # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)'
2564 # requires skipping the next token becasue we split on ' ' and '*'.
2567 continue
2569 break
2572 'Do not use variable-length arrays. Use an appropriately named '
2575 # If DISALLOW_EVIL_CONSTRUCTORS, DISALLOW_COPY_AND_ASSIGN, or
2576 # DISALLOW_IMPLICIT_CONSTRUCTORS is present, then it should be the last thing
2577 # in the class declaration.
2580 r'(DISALLOW_(EVIL_CONSTRUCTORS|COPY_AND_ASSIGN|IMPLICIT_CONSTRUCTORS))'
2582 line)
2589 # Check for use of unnamed namespaces in header files. Registration
2590 # macros are typically OK, so we allow use of "namespace {" on lines
2591 # that end with backslashes.
2596 'Do not use unnamed namespaces in header files. See '
2597 'http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces'
2602 error):
2603 """Checks for a C-style cast by looking for the pattern.
2605 This also handles sizeof(type) warnings, due to similarity of content.
2607 Args:
2608 filename: The name of the current file.
2609 linenum: The number of the line to check.
2610 line: The line of code to check.
2611 raw_line: The raw line of code to check, with comments.
2612 cast_type: The string for the C++ cast to recommend. This is either
2613 reinterpret_cast or static_cast, depending.
2614 pattern: The regular expression used to find C-style casts.
2615 error: The function to call with any errors found.
2616 """
2619 return
2621 # e.g., sizeof(int)
2626 return
2630 # The close paren is for function pointers as arguments to a function.
2631 # eg, void foo(void (*bar)(int));
2632 # The semicolon check is a more basic function check; also possibly a
2633 # function pointer typedef.
2634 # eg, void foo(int); or void foo(int) const;
2635 # The equals check is for function pointer assignment.
2636 # eg, void *(*foo)(int) = ...
2637 #
2638 # Right now, this will only catch cases where there's a single argument, and
2639 # it's unnamed. It should probably be expanded to check for multiple
2640 # arguments with some unnamed.
2648 return
2650 # At this point, all that should be left is actual casts.
2656 _HEADERS_CONTAINING_TEMPLATES = (
2674 )),
2686 # gcc extensions.
2687 # Note: std::hash is their hash, ::hash is our hash
2691 )
2693 _HEADERS_ACCEPTED_BUT_NOT_PROMOTED = {
2694 # We can trust with reasonable confidence that map gives us pair<>, too.
2696 }
2700 _re_pattern_algorithm_header = []
2703 # Match max<type>(..., ...), max(..., ...), but not foo->max, foo.max or
2704 # type::max().
2707 _template,
2710 _re_pattern_templates = []
2716 _header))
2720 """Check if these two filenames belong to the same module.
2722 The concept of a 'module' here is a as follows:
2723 foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the
2724 same 'module' if they are in the same directory.
2725 some/path/public/xyzzy and some/path/internal/xyzzy are also considered
2726 to belong to the same module here.
2728 If the filename_cc contains a longer path than the filename_h, for example,
2729 '/absolute/path/to/base/sysinfo.cc', and this file would include
2730 'base/sysinfo.h', this function also produces the prefix needed to open the
2731 header. This is used by the caller of this function to more robustly open the
2732 header file. We don't have access to the real include paths in this context,
2733 so we need this guesswork here.
2735 Known bugs: tools/base/bar.cc and base/bar.h belong to the same module
2736 according to this implementation. Because of this, this function gives
2737 some false positives. This should be sufficiently rare in practice.
2739 Args:
2740 filename_cc: is the path for the .cc file
2741 filename_h: is the path for the header path
2743 Returns:
2744 Tuple with a bool and a string:
2745 bool: True if filename_cc and filename_h belong to the same module.
2746 string: the additional prefix needed to open the header file.
2747 """
2775 """Fill up the include_state with new includes found from the file.
2777 Args:
2778 filename: the name of the header to read.
2779 include_state: an _IncludeState instance in which the headers are inserted.
2780 io: The io factory to use to read the file. Provided for testability.
2782 Returns:
2783 True if a header was succesfully added. False otherwise.
2784 """
2789 return False
2797 # The value formatting is cute, but not really used right now.
2798 # What matters here is that the key is in include_state.
2800 return True
2805 """Reports for missing stl includes.
2807 This function will output warnings to make sure you are including the headers
2808 necessary for the stl containers and functions that you use. We only give one
2809 reason to include a header. For example, if you use both equal_to<> and
2810 less<> in a .h file, only one (the latter in the file) of these will be
2811 reported as a reason to include the <functional>.
2813 Args:
2814 filename: The name of the current file.
2815 clean_lines: A CleansedLines instance containing the file.
2816 include_state: An _IncludeState instance.
2817 error: The function to call with any errors found.
2818 io: The IO factory to use to read the header file. Provided for unittest
2819 injection.
2820 """
2822 # Example of required: { '<functional>': (1219, 'less<>') }
2827 continue
2829 # String is special -- it is a non-templatized type in STL.
2832 # Don't warn about strings in non-STL namespaces:
2833 # (We check only the first match per line; good enough.)
2842 # The following function is just a speed up, no semantics are changed.
2844 continue
2850 # The policy is that if you #include something in foo.h you don't need to
2851 # include it again in foo.cc. Here, we will look at possible includes.
2852 # Let's copy the include_state so it is only messed up within this function.
2855 # Did we find the header for this file (if any) and succesfully load it?
2858 # Use the absolute path so that matching works properly.
2861 # For Emacs's flymake.
2862 # If cpplint is invoked from Emacs's flymake, a temporary file is generated
2863 # by flymake and that file name might end with '_flymake.cc'. In that case,
2864 # restore original file name here so that the corresponding header file can be
2865 # found.
2866 # e.g. If the file name is 'foo_flymake.cc', we should search for 'foo.h'
2867 # instead of 'foo_flymake.h'
2870 # include_state is modified during iteration, so we iterate over a copy of
2871 # the keys.
2878 # If we can't find the header file for a .cc, assume it's because we don't
2879 # know where to look. In that case we'll give up as we're not sure they
2880 # didn't include it in the .h file.
2881 # TODO(unknown): Do a better job of finding .h files so we are confident that
2882 # not having the .h file means there isn't one.
2884 return
2886 # All the lines have been processed, report the errors found.
2892 continue
2902 """Processes a single line in the file.
2904 Args:
2905 filename: Filename of the file that is being processed.
2906 file_extension: The extension (dot not included) of the file.
2907 clean_lines: An array of strings, each representing a line of the file,
2908 with comments stripped.
2909 line: Number of line being processed.
2910 include_state: An _IncludeState instance in which the headers are inserted.
2911 function_state: A _FunctionState instance which counts function lines, etc.
2912 class_state: A _ClassState instance which maintains information about
2913 the current stack of nested class declarations being parsed.
2914 error: A callable to which errors are reported, which takes 4 arguments:
2915 filename, line number, error level, and message
2917 """
2924 error)
2932 """Performs lint checks and reports any errors to the given error function.
2934 Args:
2935 filename: Filename of the file that is being processed.
2936 file_extension: The extension (dot not included) of the file.
2937 lines: An array of strings, each representing a line of the file, with the
2938 last element being empty if the file is termined with a newline.
2939 error: A callable to which errors are reported, which takes 4 arguments:
2940 """
2964 # We check here rather than inside ProcessLine so that we see raw
2965 # lines rather than "cleaned" lines.
2971 """Does google-lint on a single file.
2973 Args:
2974 filename: The name of the file to parse.
2976 vlevel: The level of errors to report. Every error of confidence
2977 >= verbose_level will be reported. 0 is a good default.
2978 """
2983 # Support the UNIX convention of using "-" for stdin. Note that
2984 # we are not opening the file with universal newline support
2985 # (which codecs doesn't support anyway), so the resulting lines do
2986 # contain trailing '\r' characters if we are reading a file that
2987 # has CRLF endings.
2988 # If after the split a trailing '\r' is present, it is removed
2989 # below. If it is not expected to be present (i.e. os.linesep !=
2990 # '\r\n' as in Windows), a warning is issued below if this file
2991 # is processed.
3002 # Remove trailing '\r'.
3011 return
3013 # Note, if no dot is found, this will give the entire filename as the ext.
3016 # When reading from stdin, the extension is unknown, so no cpplint tests
3017 # should rely on the extension.
3024 # Use 0 for linenum since outputing only one error for potentially
3025 # several lines.
3034 """Prints a brief usage string and exits, optionally with an error message.
3036 Args:
3037 message: The optional error message.
3038 """
3047 """Prints a list of all the error-categories used by error messages.
3049 These are the categories used to filter messages via --filter.
3050 """
3056 """Parses the command line arguments.
3058 This may set the output format and verbosity level as side-effects.
3060 Args:
3061 args: The command line arguments:
3063 Returns:
3064 The list of filenames to lint.
3065 """
3084 output_format = val
3088 filters = val
3094 counting_style = val
3104 return filenames
3110 # Change stderr to write with replacement characters so we don't die
3111 # if we try to print something containing non-ASCII characters.