ament_cpplint.cpplint module

Does google-lint on c++ files.

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

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

ament_cpplint.cpplint.CheckAltTokens(filename, clean_lines, linenum, error)

Check alternative keywords being used in boolean expressions.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckBraces(filename, clean_lines, linenum, error)

Looks for misplaced braces (e.g. at the end of line).

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error)

Checks for horizontal spacing near commas.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: The function to call with any errors found.

ament_cpplint.cpplint.CheckCStyleCast(filename, clean_lines, linenum, cast_type, pattern, error)

Checks for a C-style cast by looking for the pattern.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. cast_type: The string for the C++ cast to recommend. This is either

reinterpret_cast, static_cast, or const_cast, depending.

pattern: The regular expression used to find C-style casts. error: The function to call with any errors found.

Returns:

True if an error was emitted. False otherwise.

ament_cpplint.cpplint.CheckCasts(filename, clean_lines, linenum, error)

Various cast related checks.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckCheck(filename, clean_lines, linenum, error)

Checks the use of CHECK and EXPECT macros.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckCommaSpacing(filename, clean_lines, linenum, error)

Checks for horizontal spacing near commas and semicolons.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckComment(line, filename, linenum, next_line_start, error)

Checks for common mistakes in comments.

Args:

line: The line in question. filename: The name of the current file. linenum: The number of the line to check. next_line_start: The first non-whitespace column of the next line. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckEmptyBlockBody(filename, clean_lines, linenum, error)

Look for empty loop/conditional body with only a single semicolon.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForBadCharacters(filename, lines, error)

Logs an error for each line containing bad characters.

Two kinds of bad characters:

1. Unicode replacement characters: These indicate that either the file contained invalid UTF-8 (likely) or Unicode replacement characters (which it shouldn’t). Note that it’s possible for this to throw off line numbering if the invalid UTF-8 occurred adjacent to a newline.

2. NUL bytes. These are problematic for some tools.

Args:

filename: The name of the current file. lines: An array of strings, each representing a line of the file. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForCopyright(filename, lines, error)

Logs an error if no Copyright message appears at the top of the file.

ament_cpplint.cpplint.CheckForFunctionLengths(filename, clean_lines, linenum, function_state, error)

Reports for long function bodies.

For an overview why this is done, see: https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions

Uses a simplistic algorithm assuming other style guidelines (especially spacing) are followed. Only checks unindented functions, so class members are unchecked. Trivial bodies are unchecked, so constructors with huge initializer lists may be missed. Blank/comment lines are not counted so as to avoid encouraging the removal of vertical space and comments just to get through a lint check. NOLINT on the last line of a function disables this check.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. function_state: Current function name and lines in body so far. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForHeaderGuard(filename, clean_lines, error)

Checks that the file contains a header guard.

Logs an error if no #ifndef header guard is present. For other headers, checks that the full pathname is used.

Args:

filename: The name of the C++ header file. clean_lines: A CleansedLines instance containing the file. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error, io=<module 'codecs' from '/usr/lib/python3.10/codecs.py'>)

Reports for missing stl includes.

This function will output warnings to make sure you are including the headers necessary for the stl containers and functions that you use. We only give one reason to include a header. For example, if you use both equal_to<> and less<> in a .h file, only one (the latter in the file) of these will be reported as a reason to include the <functional>.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. include_state: An _IncludeState instance. error: The function to call with any errors found. io: The IO factory to use to read the header file. Provided for unittest

injection.

ament_cpplint.cpplint.CheckForMultilineCommentsAndStrings(filename, clean_lines, linenum, error)

Logs an error if we see /* … */ or “…” that extend past one line.

/* … */ comments are legit inside macros, for one line. Otherwise, we prefer // comments, so it’s ok to warn about the other. Likewise, it’s ok for strings to extend across multiple lines, as long as a line continuation character (backslash) terminates each line. Although not currently prohibited by the C++ style guide, it’s ugly and unnecessary. We don’t do well with either in this lint program, so we warn about both.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, error)

ament_cpplint.cpplint.CheckForNewlineAtEOF(filename, lines, error)

Logs an error if there is no newline char at the end of the file.

Args:

filename: The name of the current file. lines: An array of strings, each representing a line of the file. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForNonConstReference(filename, clean_lines, linenum, nesting_state, error)

Check for non-const references.

Separate from CheckLanguage since it scans backwards from current line, instead of scanning forward.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: The function to call with any errors found.

ament_cpplint.cpplint.CheckForNonStandardConstructs(filename, clean_lines, linenum, nesting_state, error)

Logs an error if we see certain non-ANSI constructs ignored by gcc-2.

Complain about several constructs which gcc-2 accepts, but which are not standard C++. Warning about these in lint is one way to ease the transition to new compilers. - put storage class first (e.g. “static const” instead of “const static”). - “%lld” instead of %qd” in printf-type functions. - “%1$d” is non-standard in printf-type functions. - “%” is an undefined character escape sequence. - text after #endif is not allowed. - invalid inner-style forward declaration. - >? and <? operators, and their >?= and <?= cousins.

Additionally, check for constructor/destructor style violations and reference members, as it is very convenient to do so while checking for gcc-2 compliance.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: A callable to which errors are reported, which takes 4 arguments:

filename, line number, error level, and message

ament_cpplint.cpplint.CheckGlobalStatic(filename, clean_lines, linenum, error)

Check for unsafe global or static objects.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckHeaderFileIncluded(filename, include_state, error)

Logs an error if a source file does not include its header.

ament_cpplint.cpplint.CheckIncludeLine(filename, clean_lines, linenum, include_state, error)

Check rules that are applicable to #include lines.

Strings on #include lines are NOT removed from elided line, to make certain tasks easier. However, to prevent false positives, checks applicable to #include lines in CheckLanguage must be put here.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. include_state: An _IncludeState instance in which the headers are inserted. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckInvalidIncrement(filename, clean_lines, linenum, error)

Checks for invalid increment *count++.

For example following function: void increment_counter(int* count) {

*count++;

} is invalid, because it effectively does count++, moving pointer, and should be replaced with ++*count, (*count)++ or *count += 1.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckItemIndentationInNamespace(filename, raw_lines_no_comments, linenum, error)

ament_cpplint.cpplint.CheckLanguage(filename, clean_lines, linenum, file_extension, include_state, nesting_state, error)

Checks rules from the ‘C++ language rules’ section of cppguide.html.

Some of these rules are hard to test (function overloading, using uint32 inappropriately), but we do the best we can.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. file_extension: The extension (without the dot) of the filename. include_state: An _IncludeState instance in which the headers are inserted. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: The function to call with any errors found.

ament_cpplint.cpplint.CheckMakePairUsesDeduction(filename, clean_lines, linenum, error)

Check that make_pair’s template arguments are deduced.

G++ 4.6 in C++11 mode fails badly if make_pair’s template arguments are specified explicitly, and such use isn’t intended in any case.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckOperatorSpacing(filename, clean_lines, linenum, error)

Checks for horizontal spacing around operators.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckParenthesisSpacing(filename, clean_lines, linenum, error)

Checks for horizontal spacing around parentheses.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckPosixThreading(filename, clean_lines, linenum, error)

Checks for calls to thread-unsafe functions.

Much code has been originally written without consideration of multi-threading. Also, engineers are relying on their old experience; they have learned posix before threading extensions were added. These tests guide the engineers to use thread-safe functions (when using posix directly).

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckPrintf(filename, clean_lines, linenum, error)

Check for printf related issues.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckRedundantOverrideOrFinal(filename, clean_lines, linenum, error)

Check if line contains a redundant “override” or “final” virt-specifier.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckRedundantVirtual(filename, clean_lines, linenum, error)

Check if line contains a redundant “virtual” function-specifier.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckSectionSpacing(filename, clean_lines, class_info, linenum, error)

Checks for additional blank line issues related to sections.

Currently the only thing checked here is blank line before protected/private.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. class_info: A _ClassInfo objects. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckSpacing(filename, clean_lines, linenum, nesting_state, error)

Checks for the correctness of various spacing issues in the code.

Things we check for: spaces around operators, spaces after if/for/while/switch, no spaces around parens in function calls, two spaces between code and comment, don’t start a block with a blank line, don’t end a function with a blank line, don’t add a blank line after public/protected/private, don’t have too many blank lines in a row.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: The function to call with any errors found.

ament_cpplint.cpplint.CheckSpacingForFunctionCall(filename, clean_lines, linenum, error)

Checks for the correctness of various spacing around function calls.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckStyle(filename, clean_lines, linenum, file_extension, nesting_state, error)

Checks rules from the ‘C++ style rules’ section of cppguide.html.

Most of these rules are hard to test (naming, comment style), but we do what we can. In particular we check for 2-space indents, line lengths, tab usage, spaces inside code, etc.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. file_extension: The extension (without the dot) of the filename. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: The function to call with any errors found.

ament_cpplint.cpplint.CheckTrailingSemicolon(filename, clean_lines, linenum, error)

Looks for redundant trailing semicolon.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CheckVlogArguments(filename, clean_lines, linenum, error)

Checks that VLOG() is only used for defining a logging level.

For example, VLOG(2) is correct. VLOG(INFO), VLOG(WARNING), VLOG(ERROR), and VLOG(FATAL) are not.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.CleanseComments(line)

Removes //-comments and single-line C-style /* */ comments.

Args:

line: A line of C++ source.

Returns:

The line with single-line comments removed.

ament_cpplint.cpplint.CleanseRawStrings(raw_lines)

Removes C++11 raw strings from lines.

Before:

static const char kData[] = R”(

multi-line string )”;

After:

static const char kData[] = “”

(replaced by blank line) “”;

Args:

raw_lines: list of raw lines.

Returns:

list of lines with C++11 raw strings replaced by empty strings.

class ament_cpplint.cpplint.CleansedLines(lines)

Bases: object

Holds 4 copies of all lines with different preprocessing applied to them.

1. elided member contains lines without strings and comments.

2. lines member contains lines without comments.

3. raw_lines member contains all the lines without processing.

4. lines_without_raw_strings member is same as raw_lines, but with C++11 raw strings removed.

All these members are of <type ‘list’>, and of the same length.

NumLines()

Returns the number of lines represented.

ament_cpplint.cpplint.CloseExpression(clean_lines, linenum, pos)

If input points to ( or { or [ or <, finds the position that closes it.

If lines[linenum][pos] points to a ‘(’ or ‘{’ or ‘[’ or ‘<’, finds the linenum/pos that correspond to the closing of the expression.

TODO(unknown): cpplint spends a fair bit of time matching parentheses. Ideally we would want to index all opening and closing parentheses once and have CloseExpression be just a simple lookup, but due to preprocessor tricks, this is not so easy.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. pos: A position on the line.

Returns:

A tuple (line, linenum, pos) pointer past the closing brace, or (line, len(lines), -1) if we never find a close. Note we ignore strings and comments when matching; and the line we return is the ‘cleansed’ line at linenum.

ament_cpplint.cpplint.Error(filename, linenum, category, confidence, message)

Logs the fact we’ve found a lint error.

We log where the error was found, and also our confidence in the error, that is, how certain we are this is a legitimate style regression, and not a misidentification or a use that’s sometimes justified.

False positives can be suppressed by the use of “cpplint(category)” comments on the offending line. These are parsed into _error_suppressions.

Args:

filename: The name of the file containing the error. linenum: The number of the line containing the error. category: A string used to describe the “category” this bug

falls under: “whitespace”, say, or “runtime”. Categories may have a hierarchy separated by slashes: “whitespace/indent”.

confidence: A number from 1-5 representing a confidence score for

the error, with 5 meaning that we are certain of the problem, and 1 meaning that it could be a legitimate construct.

message: The error message.

ament_cpplint.cpplint.ExpectingFunctionArgs(clean_lines, linenum)

Checks whether where function type arguments are expected.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check.

Returns:

True if the line at ‘linenum’ is inside something that expects arguments of function types.

class ament_cpplint.cpplint.FileInfo(filename)

Bases: object

Provides utility functions for filenames.

FileInfo provides easy access to the components of a file’s path relative to the project root.

BaseName()

File base name - text after the final slash, before the final period.

Extension()

File extension - text following the final period, includes that period.

FullName()

Make Windows paths like Unix.

IsSource()

File has a source file extension.

NoExtension()

File has no source file extension.

RepositoryName()

FullName after removing the local path to the repository.

If we have a real absolute path name here we can try to do something smart: detecting the root of the checkout and truncating /path/to/checkout from the name so that we get header guards that don’t include things like “C:\Documents and Settings\…” or “/home/username/…” in them and thus people on different computers who have checked the source out to different locations won’t see bogus errors.

Split()

Splits the file into the directory, basename, and extension.

For ‘chrome/browser/browser.cc’, Split() would return (‘chrome/browser’, ‘browser’, ‘.cc’)

Returns:

A tuple of (directory, basename, extension).

ament_cpplint.cpplint.FilesBelongToSameModule(filename_cc, filename_h)

Check if these two filenames belong to the same module.

The concept of a ‘module’ here is a as follows: foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the same ‘module’ if they are in the same directory. some/path/public/xyzzy and some/path/internal/xyzzy are also considered to belong to the same module here.

If the filename_cc contains a longer path than the filename_h, for example, ‘/absolute/path/to/base/sysinfo.cc’, and this file would include ‘base/sysinfo.h’, this function also produces the prefix needed to open the header. This is used by the caller of this function to more robustly open the header file. We don’t have access to the real include paths in this context, so we need this guesswork here.

Known bugs: tools/base/bar.cc and base/bar.h belong to the same module according to this implementation. Because of this, this function gives some false positives. This should be sufficiently rare in practice.

Args:

filename_cc: is the path for the source (e.g. .cc) file filename_h: is the path for the header path

Returns:

Tuple with a bool and a string: bool: True if filename_cc and filename_h belong to the same module. string: the additional prefix needed to open the header file.

ament_cpplint.cpplint.FindCheckMacro(line)

Find a replaceable CHECK-like macro.

Args:

line: line to search on.

Returns:

(macro name, start position), or (None, -1) if no replaceable macro is found.

ament_cpplint.cpplint.FindEndOfExpressionInLine(line, startpos, stack)

Find the position just after the end of current parenthesized expression.

Args:

line: a CleansedLines line. startpos: start searching at this position. stack: nesting stack at startpos.

Returns:

On finding matching end: (index just after matching end, None) On finding an unclosed expression: (-1, None) Otherwise: (-1, new stack at end of this line)

ament_cpplint.cpplint.FindNextMultiLineCommentEnd(lines, lineix)

We are inside a comment, find the end marker.

ament_cpplint.cpplint.FindNextMultiLineCommentStart(lines, lineix)

Find the beginning marker for a multiline comment.

ament_cpplint.cpplint.FindStartOfExpressionInLine(line, endpos, stack)

Find position at the matching start of current expression.

This is almost the reverse of FindEndOfExpressionInLine, but note that the input position and returned position differs by 1.

Args:

line: a CleansedLines line. endpos: start searching at this position. stack: nesting stack at endpos.

Returns:

On finding matching start: (index at matching start, None) On finding an unclosed expression: (-1, None) Otherwise: (-1, new stack at beginning of this line)

ament_cpplint.cpplint.FlagCxx11Features(filename, clean_lines, linenum, error)

Flag those c++11 features that we only allow in certain places.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.FlagCxx14Features(filename, clean_lines, linenum, error)

Flag those C++14 features that we restrict.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

ament_cpplint.cpplint.GetAllExtensions()

ament_cpplint.cpplint.GetHeaderExtensions()

ament_cpplint.cpplint.GetHeaderGuardCPPVariable(filename)

Returns the CPP variable that should be used as a header guard.

Args:

filename: The name of a C++ header file.

Returns:

The CPP variable that should be used as a header guard in the named file.

ament_cpplint.cpplint.GetIndentLevel(line)

Return the number of leading spaces in line.

Args:

line: A string to check.

Returns:

An integer count of leading spaces, possibly zero.

ament_cpplint.cpplint.GetLineWidth(line)

Determines the width of the line in column positions.

Args:

line: A string, which may be a Unicode string.

Returns:

The width of the line in column positions, accounting for Unicode combining characters and wide characters.

ament_cpplint.cpplint.GetNonHeaderExtensions()

ament_cpplint.cpplint.GetPreviousNonBlankLine(clean_lines, linenum)

Return the most recent non-blank line and its line number.

Args:

clean_lines: A CleansedLines instance containing the file contents. linenum: The number of the line to check.

Returns:

A tuple with two elements. The first element is the contents of the last non-blank line before the current line, or the empty string if this is the first non-blank line. The second is the line number of that line, or -1 if this is the first non-blank line.

ament_cpplint.cpplint.IsBlankLine(line)

Returns true if the given line is blank.

We consider a line to be blank if the line is empty or consists of only white spaces.

Args:

line: A line of a string.

Returns:

True, if the given line is blank.

ament_cpplint.cpplint.IsBlockInNameSpace(nesting_state, is_forward_declaration)

Checks that the new block is directly in a namespace.

Args:

nesting_state: The _NestingState object that contains info about our state. is_forward_declaration: If the class is a forward declared class.

Returns:

Whether or not the new block is directly in a namespace.

ament_cpplint.cpplint.IsCppString(line)

Does line terminate so, that the next symbol is in string constant.

This function does not consider single-line nor multi-line comments.

Args:

line: is a partial line of code starting from the 0..n.

Returns:

True, if next character appended to ‘line’ is inside a string constant.

ament_cpplint.cpplint.IsDecltype(clean_lines, linenum, column)

Check if the token ending on (linenum, column) is decltype().

Args:

clean_lines: A CleansedLines instance containing the file. linenum: the number of the line to check. column: end column of the token to check.

Returns:

True if this token is decltype() expression, False otherwise.

ament_cpplint.cpplint.IsDerivedFunction(clean_lines, linenum)

Check if current line contains an inherited function.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check.

Returns:

True if current line contains a function with “override” virt-specifier.

ament_cpplint.cpplint.IsErrorSuppressedByNolint(category, linenum)

Returns true if the specified error category is suppressed on this line.

Consults the global error_suppressions map populated by ParseNolintSuppressions/ProcessGlobalSuppresions/ResetNolintSuppressions.

Args:

category: str, the category of the error. linenum: int, the current line number.

Returns:

bool, True iff the error should be suppressed due to a NOLINT comment or global suppression.

ament_cpplint.cpplint.IsForwardClassDeclaration(clean_lines, linenum)

ament_cpplint.cpplint.IsHeaderExtension(file_extension)

ament_cpplint.cpplint.IsInitializerList(clean_lines, linenum)

Check if current line is inside constructor initializer list.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check.

Returns:

True if current line appears to be inside constructor initializer list, False otherwise.

ament_cpplint.cpplint.IsMacroDefinition(clean_lines, linenum)

ament_cpplint.cpplint.IsOutOfLineMethodDefinition(clean_lines, linenum)

Check if current line contains an out-of-line method definition.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check.

Returns:

True if current line contains an out-of-line method definition.

ament_cpplint.cpplint.Match(pattern, s)

Matches the string with the pattern, caching the compiled regexp.

class ament_cpplint.cpplint.NestingState

Bases: object

Holds states related to parsing braces.

CheckCompletedBlocks(filename, error)

Checks that all classes and namespaces have been completely parsed.

Call this when all lines in a file have been processed. Args:

filename: The name of the current file. error: The function to call with any errors found.

InAsmBlock()

Check if we are currently one level inside an inline ASM block.

Returns:

True if the top of the stack is a block containing inline ASM.

InClassDeclaration()

Check if we are currently one level inside a class or struct declaration.

Returns:

True if top of the stack is a class/struct, False otherwise.

InExternC()

Check if we are currently one level inside an ‘extern “C”’ block.

Returns:

True if top of the stack is an extern block, False otherwise.

InNamespaceBody()

Check if we are currently one level inside a namespace body.

Returns:

True if top of the stack is a namespace block, False otherwise.

InTemplateArgumentList(clean_lines, linenum, pos)

Check if current position is inside template argument list.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. pos: position just after the suspected template argument.

Returns:

True if (linenum, pos) is inside template arguments.

InnermostClass()

Get class info on the top of the stack.

Returns:

A _ClassInfo object if we are inside a class, or None otherwise.

SeenOpenBrace()

Check if we have seen the opening brace for the innermost block.

Returns:

True if we have seen the opening brace, False if the innermost block is still expecting an opening brace.

Update(filename, clean_lines, linenum, error)

Update nesting state with current line.

Args:

filename: The name of the current file. clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. error: The function to call with any errors found.

UpdatePreprocessor(line)

Update preprocessor stack.

We need to handle preprocessors due to classes like this:

#ifdef SWIG struct ResultDetailsPageElementExtensionPoint { #else struct ResultDetailsPageElementExtensionPoint : public Extension { #endif

We make the following assumptions (good enough for most files): - Preprocessor condition evaluates to true from #if up to first

#else/#elif/#endif.

• Preprocessor condition evaluates to false from #else/#elif up to #endif. We still perform lint checks on these lines, but these do not affect nesting stack.

Args:

line: current line to check.

ament_cpplint.cpplint.ParseArguments(args)

Parses the command line arguments.

This may set the output format and verbosity level as side-effects.

Args:

args: The command line arguments:

Returns:

The list of filenames to lint.

ament_cpplint.cpplint.ParseNolintSuppressions(filename, raw_line, linenum, error)

Updates the global list of line error-suppressions.

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

Args:

filename: str, the name of the input file. raw_line: str, the line of input text, with comments. linenum: int, the number of the current line. error: function, an error handler.

ament_cpplint.cpplint.PathSplitToList(path)

Returns the path split into a list by the separator.

Args:

path: An absolute or relative path (e.g. ‘/a/b/c/’ or ‘../a’)

Returns:

A list of path components (e.g. [‘a’, ‘b’, ‘c]).

ament_cpplint.cpplint.PrintCategories()

Prints a list of all the error-categories used by error messages.

These are the categories used to filter messages via –filter.

ament_cpplint.cpplint.PrintUsage(message)

Prints a brief usage string and exits, optionally with an error message.

Args:

message: The optional error message.

ament_cpplint.cpplint.PrintVersion()

ament_cpplint.cpplint.ProcessConfigOverrides(filename)

Loads the configuration files and processes the config overrides.

Args:

filename: The name of the file being processed by the linter.

Returns:

False if the current |filename| should not be processed further.

ament_cpplint.cpplint.ProcessExtensionsOption(val)

ament_cpplint.cpplint.ProcessFile(filename, vlevel, extra_check_functions=None)

Does google-lint on a single file.

Args:

filename: The name of the file to parse.

vlevel: The level of errors to report. Every error of confidence >= verbose_level will be reported. 0 is a good default.

extra_check_functions: An array of additional check functions that will be

run on each source line. Each function takes 4 arguments: filename, clean_lines, line, error

ament_cpplint.cpplint.ProcessFileData(filename, file_extension, lines, error, extra_check_functions=None)

Performs lint checks and reports any errors to the given error function.

Args:

filename: Filename of the file that is being processed. file_extension: The extension (dot not included) of the file. lines: An array of strings, each representing a line of the file, with the

last element being empty if the file is terminated with a newline.

error: A callable to which errors are reported, which takes 4 arguments:

filename, line number, error level, and message

extra_check_functions: An array of additional check functions that will be

run on each source line. Each function takes 4 arguments: filename, clean_lines, line, error

ament_cpplint.cpplint.ProcessGlobalSuppresions(lines)

Updates the list of global error suppressions.

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

Args:

lines: An array of strings, each representing a line of the file, with the

last element being empty if the file is terminated with a newline.

ament_cpplint.cpplint.ProcessHppHeadersOption(val)

ament_cpplint.cpplint.ProcessIncludeOrderOption(val)

ament_cpplint.cpplint.ProcessLine(filename, file_extension, clean_lines, line, include_state, function_state, nesting_state, error, extra_check_functions=None)

Processes a single line in the file.

Args:

filename: Filename of the file that is being processed. file_extension: The extension (dot not included) of the file. clean_lines: An array of strings, each representing a line of the file,

with comments stripped.

line: Number of line being processed. include_state: An _IncludeState instance in which the headers are inserted. function_state: A _FunctionState instance which counts function lines, etc. nesting_state: A NestingState instance which maintains information about

the current stack of nested blocks being parsed.

error: A callable to which errors are reported, which takes 4 arguments:

filename, line number, error level, and message

extra_check_functions: An array of additional check functions that will be

run on each source line. Each function takes 4 arguments: filename, clean_lines, line, error

ament_cpplint.cpplint.RemoveMultiLineComments(filename, lines, error)

Removes multiline (c-style) comments from lines.

ament_cpplint.cpplint.RemoveMultiLineCommentsFromRange(lines, begin, end)

Clears a range of lines for multi-line comments.

ament_cpplint.cpplint.ReplaceAll(pattern, rep, s)

Replaces instances of pattern in a string with a replacement.

The compiled regex is kept in a cache shared by Match and Search.

Args:

pattern: regex pattern rep: replacement text s: search string

Returns:

string with replacements made (or original string if no replacements)

ament_cpplint.cpplint.ResetNolintSuppressions()

Resets the set of NOLINT suppressions to empty.

ament_cpplint.cpplint.ReverseCloseExpression(clean_lines, linenum, pos)

If input points to ) or } or ] or >, finds the position that opens it.

If lines[linenum][pos] points to a ‘)’ or ‘}’ or ‘]’ or ‘>’, finds the linenum/pos that correspond to the opening of the expression.

Args:

clean_lines: A CleansedLines instance containing the file. linenum: The number of the line to check. pos: A position on the line.

Returns:

A tuple (line, linenum, pos) pointer at the opening brace, or (line, 0, -1) if we never find the matching opening brace. Note we ignore strings and comments when matching; and the line we return is the ‘cleansed’ line at linenum.

ament_cpplint.cpplint.Search(pattern, s)

Searches the string for the pattern, caching the compiled regexp.

ament_cpplint.cpplint.ShouldCheckNamespaceIndentation(nesting_state, is_namespace_indent_item, raw_lines_no_comments, linenum)

This method determines if we should apply our namespace indentation check.

Args:

nesting_state: The current nesting state. is_namespace_indent_item: If we just put a new class on the stack, True.

If the top of the stack is not a class, or we did not recently add the class, False.

raw_lines_no_comments: The lines without the comments. linenum: The current line number we are processing.

Returns:

True if we should apply our namespace indentation check. Currently, it only works for classes and namespaces inside of a namespace.

ament_cpplint.cpplint.UpdateIncludeState(filename, include_dict, io=<module 'codecs' from '/usr/lib/python3.10/codecs.py'>)

Fill up the include_dict with new includes found from the file.

Args:

filename: the name of the header to read. include_dict: a dictionary in which the headers are inserted. io: The io factory to use to read the file. Provided for testability.

Returns:

True if a header was successfully added. False otherwise.

ament_cpplint.cpplint.iteritems()

D.items() -> a set-like object providing a view on D’s items

ament_cpplint.cpplint.itervalues()

D.values() -> an object providing a view on D’s values

ament_cpplint.cpplint.main()

ament_cpplint.cpplint.unicode_escape_decode(x)