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)
| 2645 | |
| 2646 | |
| 2647 | def CheckSpacing(filename, clean_lines, linenum, nesting_state, error): |
| 2648 | """Checks for the correctness of various spacing issues in the code. |
| 2649 | |
| 2650 | Things we check for: spaces around operators, spaces after |
| 2651 | if/for/while/switch, no spaces around parens in function calls, two |
| 2652 | spaces between code and comment, don't start a block with a blank |
| 2653 | line, don't end a function with a blank line, don't add a blank line |
| 2654 | after public/protected/private, don't have too many blank lines in a row. |
| 2655 | |
| 2656 | Args: |
| 2657 | filename: The name of the current file. |
| 2658 | clean_lines: A CleansedLines instance containing the file. |
| 2659 | linenum: The number of the line to check. |
| 2660 | nesting_state: A _NestingState instance which maintains information about |
| 2661 | the current stack of nested blocks being parsed. |
| 2662 | error: The function to call with any errors found. |
| 2663 | """ |
| 2664 | |
| 2665 | # Don't use "elided" lines here, otherwise we can't check commented lines. |
| 2666 | # Don't want to use "raw" either, because we don't want to check inside C++11 |
| 2667 | # raw strings, |
| 2668 | raw = clean_lines.lines_without_raw_strings |
| 2669 | line = raw[linenum] |
| 2670 | |
| 2671 | # Before nixing comments, check if the line is blank for no good |
| 2672 | # reason. This includes the first line after a block is opened, and |
| 2673 | # blank lines at the end of a function (ie, right before a line like '}' |
| 2674 | # |
| 2675 | # Skip all the blank line checks if we are immediately inside a |
| 2676 | # namespace body. In other words, don't issue blank line warnings |
| 2677 | # for this block: |
| 2678 | # namespace { |
| 2679 | # |
| 2680 | # } |
| 2681 | # |
| 2682 | # A warning about missing end of namespace comments will be issued instead. |
| 2683 | if IsBlankLine(line) and not nesting_state.InNamespaceBody(): |
| 2684 | elided = clean_lines.elided |
| 2685 | prev_line = elided[linenum - 1] |
| 2686 | prevbrace = prev_line.rfind('{') |
| 2687 | # TODO(unknown): Don't complain if line before blank line, and line after, |
| 2688 | # both start with alnums and are indented the same amount. |
| 2689 | # This ignores whitespace at the start of a namespace block |
| 2690 | # because those are not usually indented. |
| 2691 | if prevbrace != -1 and prev_line[prevbrace:].find('}') == -1: |
| 2692 | # OK, we have a blank line at the start of a code block. Before we |
| 2693 | # complain, we check if it is an exception to the rule: The previous |
| 2694 | # non-empty line has the parameters of a function header that are indented |
| 2695 | # 4 spaces (because they did not fit in a 80 column line when placed on |
| 2696 | # the same line as the function name). We also check for the case where |
| 2697 | # the previous line is indented 6 spaces, which may happen when the |
| 2698 | # initializers of a constructor do not fit into a 80 column line. |
| 2699 | exception = False |
| 2700 | if Match(r' {6}\w', prev_line): # Initializer list? |
| 2701 | # We are looking for the opening column of initializer list, which |
| 2702 | # should be indented 4 spaces to cause 6 space indentation afterwards. |
| 2703 | search_position = linenum-2 |
| 2704 | while (search_position >= 0 |
no test coverage detected