MCPcopy Create free account
hub / github.com/alibaba/GraphScope / CheckSpacing

Function CheckSpacing

analytical_engine/misc/cpplint.py:3670–3796  ·  view source on GitHub ↗

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

(filename, clean_lines, linenum, nesting_state, error)

Source from the content-addressed store, hash-verified

3668
3669
3670def CheckSpacing(filename, clean_lines, linenum, nesting_state, error):
3671 """Checks for the correctness of various spacing issues in the code.
3672
3673 Things we check for: spaces around operators, spaces after
3674 if/for/while/switch, no spaces around parens in function calls, two
3675 spaces between code and comment, don't start a block with a blank
3676 line, don't end a function with a blank line, don't add a blank line
3677 after public/protected/private, don't have too many blank lines in a row.
3678
3679 Args:
3680 filename: The name of the current file.
3681 clean_lines: A CleansedLines instance containing the file.
3682 linenum: The number of the line to check.
3683 nesting_state: A NestingState instance which maintains information about
3684 the current stack of nested blocks being parsed.
3685 error: The function to call with any errors found.
3686 """
3687
3688 # Don't use "elided" lines here, otherwise we can't check commented lines.
3689 # Don't want to use "raw" either, because we don't want to check inside C++11
3690 # raw strings,
3691 raw = clean_lines.lines_without_raw_strings
3692 line = raw[linenum]
3693
3694 # Before nixing comments, check if the line is blank for no good
3695 # reason. This includes the first line after a block is opened, and
3696 # blank lines at the end of a function (ie, right before a line like '}'
3697 #
3698 # Skip all the blank line checks if we are immediately inside a
3699 # namespace body. In other words, don't issue blank line warnings
3700 # for this block:
3701 # namespace {
3702 #
3703 # }
3704 #
3705 # A warning about missing end of namespace comments will be issued instead.
3706 #
3707 # Also skip blank line checks for 'extern "C"' blocks, which are formatted
3708 # like namespaces.
3709 if (IsBlankLine(line) and
3710 not nesting_state.InNamespaceBody() and
3711 not nesting_state.InExternC()):
3712 elided = clean_lines.elided
3713 prev_line = elided[linenum - 1]
3714 prevbrace = prev_line.rfind('{')
3715 # TODO(unknown): Don't complain if line before blank line, and line after,
3716 # both start with alnums and are indented the same amount.
3717 # This ignores whitespace at the start of a namespace block
3718 # because those are not usually indented.
3719 if prevbrace != -1 and prev_line[prevbrace:].find('}') == -1:
3720 # OK, we have a blank line at the start of a code block. Before we
3721 # complain, we check if it is an exception to the rule: The previous
3722 # non-empty line has the parameters of a function header that are indented
3723 # 4 spaces (because they did not fit in a 80 column line when placed on
3724 # the same line as the function name). We also check for the case where
3725 # the previous line is indented 6 spaces, which may happen when the
3726 # initializers of a constructor do not fit into a 80 column line.
3727 exception = False

Callers 1

CheckStyleFunction · 0.85

Calls 9

IsBlankLineFunction · 0.85
CheckCommentFunction · 0.85
SearchFunction · 0.85
InNamespaceBodyMethod · 0.80
InExternCMethod · 0.80
findMethod · 0.80
NumLinesMethod · 0.80
MatchFunction · 0.70
groupMethod · 0.45

Tested by

no test coverage detected