Function Error

tools/cpplint.py:1889–1936

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 t

(filename, linenum, category, confidence, message)

def 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 "NOLINT(category)"
    comments, NOLINTNEXTLINE or in blocks started by NOLINTBEGIN.  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.
    """
    if _ShouldPrintError(category, confidence, filename, linenum):
        _cpplint_state.IncrementErrorCount(category)
        if _cpplint_state.output_format == "vs7":
            _cpplint_state.PrintError(
                f"{filename}({linenum}): error cpplint: [{category}] {message} [{confidence}]\n"
            )
        elif _cpplint_state.output_format == "eclipse":
            sys.stderr.write(
                f"{filename}:{linenum}: warning: {message}  [{category}] [{confidence}]\n"
            )
        elif _cpplint_state.output_format == "junit":
            _cpplint_state.AddJUnitFailure(filename, linenum, message, category, confidence)
        elif _cpplint_state.output_format in ["sed", "gsed"]:
            if message in _SED_FIXUPS:
                sys.stdout.write(
                    f"{_cpplint_state.output_format} -i"
                    f" '{linenum}{_SED_FIXUPS[message]}' {filename}"
                    f" # {message}  [{category}] [{confidence}]\n"
                )
            else:
                sys.stderr.write(
                    f'# {filename}:{linenum}:  "{message}"  [{category}] [{confidence}]\n'
                )
        else:
            final_message = f"{filename}:{linenum}:  {message}  [{category}] [{confidence}]\n"
            sys.stderr.write(final_message)


# Matches standard C++ escape sequences per 2.13.2.3 of the C++ standard.