Functions | Variables
roslint.cpplint_wrapper Namespace Reference

Functions

def CheckBraces (fn, filename, clean_lines, linenum, error)
 
def CheckEmptyBlockBody (fn, filename, clean_lines, linenum, error)
 
def CheckIncludeLine (fn, filename, clean_lines, linenum, include_state, error)
 
def CheckSpacing (fn, filename, clean_lines, linenum, nesting_state, error)
 
def GetHeaderGuardCPPVariable (fn, filename)
 
def makeErrorFn (original_fn, suppress_categories, suppress_message_matches)
 
def patch (original_module)
 
def ProcessLine (fn, filename, file_extension, clean_lines, line, include_state, function_state, nesting_state, error, extra_check_functions=[])
 

Variables

 _line_length
 

Function Documentation

◆ CheckBraces()

def roslint.cpplint_wrapper.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. 

Definition at line 86 of file cpplint_wrapper.py.

◆ CheckEmptyBlockBody()

def roslint.cpplint_wrapper.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. 

Definition at line 142 of file cpplint_wrapper.py.

◆ CheckIncludeLine()

def roslint.cpplint_wrapper.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. 

Definition at line 115 of file cpplint_wrapper.py.

◆ CheckSpacing()

def roslint.cpplint_wrapper.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. 

Definition at line 123 of file cpplint_wrapper.py.

◆ GetHeaderGuardCPPVariable()

def roslint.cpplint_wrapper.GetHeaderGuardCPPVariable (   fn,
  filename 
)
Replacement for the function which determines the header guard variable, to pick one which
    matches ROS C++ Style. 

Definition at line 72 of file cpplint_wrapper.py.

◆ makeErrorFn()

def roslint.cpplint_wrapper.makeErrorFn (   original_fn,
  suppress_categories,
  suppress_message_matches 
)
Create a return a wrapped version of the error-report function which suppresses specific
    error categories. 

Definition at line 59 of file cpplint_wrapper.py.

◆ patch()

def roslint.cpplint_wrapper.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. 

Definition at line 45 of file cpplint_wrapper.py.

◆ ProcessLine()

def roslint.cpplint_wrapper.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. 

Definition at line 133 of file cpplint_wrapper.py.

Variable Documentation

◆ _line_length

roslint.cpplint_wrapper._line_length
private

Definition at line 42 of file cpplint_wrapper.py.



roslint
Author(s): Mike Purvis, Jack O'Quin
autogenerated on Sun Mar 5 2023 03:27:29