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 functi
(filename, clean_lines, linenum, nesting_state, error)
| 4143 | |
| 4144 | |
| 4145 | def CheckSpacing(filename, clean_lines, linenum, nesting_state, error): |
| 4146 | """Checks for the correctness of various spacing issues in the code. |
| 4147 | |
| 4148 | Things we check for: spaces around operators, spaces after |
| 4149 | if/for/while/switch, no spaces around parens in function calls, two |
| 4150 | spaces between code and comment, don't start a block with a blank |
| 4151 | line, don't end a function with a blank line, don't add a blank line |
| 4152 | after public/protected/private, don't have too many blank lines in a row. |
| 4153 | |
| 4154 | Args: |
| 4155 | filename: The name of the current file. |
| 4156 | clean_lines: A CleansedLines instance containing the file. |
| 4157 | linenum: The number of the line to check. |
| 4158 | nesting_state: A NestingState instance which maintains information about |
| 4159 | the current stack of nested blocks being parsed. |
| 4160 | error: The function to call with any errors found. |
| 4161 | """ |
| 4162 | |
| 4163 | # Don't use "elided" lines here, otherwise we can't check commented lines. |
| 4164 | # Don't want to use "raw" either, because we don't want to check inside C++11 |
| 4165 | # raw strings, |
| 4166 | raw = clean_lines.lines_without_raw_strings |
| 4167 | line = raw[linenum] |
| 4168 | |
| 4169 | # Before nixing comments, check if the line is blank for no good |
| 4170 | # reason. This includes the first line after a block is opened, and |
| 4171 | # blank lines at the end of a function (ie, right before a line like '}' |
| 4172 | # |
| 4173 | # Skip all the blank line checks if we are immediately inside a |
| 4174 | # namespace body. In other words, don't issue blank line warnings |
| 4175 | # for this block: |
| 4176 | # namespace { |
| 4177 | # |
| 4178 | # } |
| 4179 | # |
| 4180 | # A warning about missing end of namespace comments will be issued instead. |
| 4181 | # |
| 4182 | # Also skip blank line checks for 'extern "C"' blocks, which are formatted |
| 4183 | # like namespaces. |
| 4184 | if IsBlankLine(line) and not nesting_state.InNamespaceBody() and not nesting_state.InExternC(): |
| 4185 | elided = clean_lines.elided |
| 4186 | prev_line = elided[linenum - 1] |
| 4187 | prevbrace = prev_line.rfind("{") |
| 4188 | # TODO(google): Don't complain if line before blank line, and line after, |
| 4189 | # both start with alnums and are indented the same amount. |
| 4190 | # This ignores whitespace at the start of a namespace block |
| 4191 | # because those are not usually indented. |
| 4192 | if prevbrace != -1 and prev_line[prevbrace:].find("}") == -1: |
| 4193 | # OK, we have a blank line at the start of a code block. Before we |
| 4194 | # complain, we check if it is an exception to the rule: The previous |
| 4195 | # non-empty line has the parameters of a function header that are indented |
| 4196 | # 4 spaces (because they did not fit in a 80 column line when placed on |
| 4197 | # the same line as the function name). We also check for the case where |
| 4198 | # the previous line is indented 6 spaces, which may happen when the |
| 4199 | # initializers of a constructor do not fit into a 80 column line. |
| 4200 | exception = False |
| 4201 | if re.match(r" {6}\w", prev_line): # Initializer list? |
| 4202 | # We are looking for the opening column of initializer list, which |
no test coverage detected