Function CheckForFunctionLengths

tools/cpplint.py:4068–4135

Reports for long function bodies. For an overview why this is done, see: https://google.github.io/styleguide/cppguide.html#Write_Short_Functions Uses a simplistic algorithm assuming other style guidelines (especially spacing) are followed. Only checks unindented functions, so c

(filename, clean_lines, linenum, function_state, error)

def CheckForFunctionLengths(filename, clean_lines, linenum, function_state, error):
    """Reports for long function bodies.

    For an overview why this is done, see:
    https://google.github.io/styleguide/cppguide.html#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.
    """
    lines = clean_lines.lines
    line = lines[linenum]
    joined_line = ""

    starting_func = False
    regexp = r"(\w(\w|::|\*|\&|\s)*)\("  # decls * & space::name( ...
    if match_result := re.match(regexp, line):
        # If the name is all caps and underscores, figure it's a macro and
        # ignore it, unless it's TEST or TEST_F.
        function_name = match_result.group(1).split()[-1]
        if function_name in {"TEST", "TEST_F"} or not re.match(r"[A-Z_]+$", function_name):
            starting_func = True

    if starting_func:
        body_found = False
        for start_linenum in range(linenum, clean_lines.NumLines()):
            start_line = lines[start_linenum]
            joined_line += " " + start_line.lstrip()
            if re.search(r"(;|})", start_line):  # Declarations and trivial functions
                body_found = True
                break  # ... ignore
            if re.search(r"{", start_line):
                body_found = True
                function = re.search(r"((\w|:)*)\(", line).group(1)
                if re.match(r"TEST", function):  # Handle TEST... macros
                    parameter_regexp = re.search(r"(\(.*\))", joined_line)
                    if parameter_regexp:  # Ignore bad syntax
                        function += parameter_regexp.group(1)
                else:
                    function += "()"
                function_state.Begin(function)
                break
        if not body_found:
            # No body for the function (or evidence of a non-function) was found.
            error(
                filename,