niryo_libraries.roslint.cpplint_wrapper

module documentation

Undocumented

Function CheckBraces Complete replacement for cpplint.CheckBraces, since the brace rules for ROS C++ Style are completely different from the Google style guide ones.
Function CheckEmptyBlockBody Look for empty loop/conditional body with only a single semicolon, but allow ros-style do while loops.
Function CheckIncludeLine Run the function to get include state, but suppress all the errors, since ROS C++ Style is silent on include order, and contains no prohibition on use of streams.
Function CheckSpacing Do most of the original Spacing checks, but suppress the ones related to braces, since the ROS C++ Style rules are different.
Function GetHeaderGuardCPPVariable Replacement for the function which determines the header guard variable, to pick one which matches ROS C++ Style.
Function makeErrorFn Create a return a wrapped version of the error-report function which suppresses specific error categories.
Function patch Decorator to easily allow wrapping/overriding of the Check* functions in cpplint. Should decorate a function which matches the signature of the function it replaces expect with the addition of a fn parameter, which is a pass-through of the replaced function, in case the replacement would like call through to the original functionality.
Function ProcessLine Squelch the error about access control indents.
@patch(cpplint)
def CheckBraces(fn, filename, clean_lines, linenum, error):

Complete replacement for cpplint.CheckBraces, since the brace rules for ROS C++ Style are completely different from the Google style guide ones.

@patch(cpplint)
def CheckEmptyBlockBody(fn, filename, clean_lines, linenum, error):

Look for empty loop/conditional body with only a single semicolon, but allow ros-style do while loops.

@patch(cpplint)
def CheckIncludeLine(fn, filename, clean_lines, linenum, include_state, error):

Run the function to get include state, but suppress all the errors, since ROS C++ Style is silent on include order, and contains no prohibition on use of streams.

@patch(cpplint)
def CheckSpacing(fn, filename, clean_lines, linenum, nesting_state, error):

Do most of the original Spacing checks, but suppress the ones related to braces, since the ROS C++ Style rules are different.

@patch(cpplint)
def GetHeaderGuardCPPVariable(fn, filename):

Replacement for the function which determines the header guard variable, to pick one which matches ROS C++ Style.

def makeErrorFn(original_fn, suppress_categories, suppress_message_matches):

Create a return a wrapped version of the error-report function which suppresses specific error categories.

def patch(original_module):

Decorator to easily allow wrapping/overriding of the Check* functions in cpplint. Should decorate a function which matches the signature of the function it replaces expect with the addition of a fn parameter, which is a pass-through of the replaced function, in case the replacement would like call through to the original functionality.

@patch(cpplint)
def ProcessLine(fn, filename, file_extension, clean_lines, line, include_state, function_state, nesting_state, error, extra_check_functions=[]):

Squelch the error about access control indents.