org.codenarc.rule.formatting.AbstractSpaceAroundBraceAstVisitor.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation
Show all versions of CodeNarc Show documentation
The CodeNarc project provides a static analysis tool for Groovy code.
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.codenarc.rule.formatting
import org.codehaus.groovy.ast.ASTNode
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.ast.expr.GStringExpression
import org.codenarc.rule.AbstractAstVisitor
/**
* Abstract superclass for AstVisitor classes dealing with space around braces
*
* @author Chris Mair
*/
abstract class AbstractSpaceAroundBraceAstVisitor extends AbstractAstVisitor {
private final Stack gStringExpressionsStack = [] as Stack
@Override
void visitGStringExpression(GStringExpression expression) {
gStringExpressionsStack.push(expression)
super.visitGStringExpression(expression)
gStringExpressionsStack.pop()
}
protected boolean isNotInsideGString() {
return gStringExpressionsStack.empty()
}
protected String sourceLineOrEmpty(ASTNode node) {
(node.lineNumber == -1 || (node instanceof ClassNode && node.script)) ? '' : sourceLine(node)
}
protected String lastSourceLineOrEmpty(ASTNode node) {
(node.lineNumber == -1 || (node instanceof ClassNode && node.script)) ? '' : lastSourceLine(node)
}
/**
* Return true if the specified (1-based) index is valid and the character at that index is not a whitespace character
* @param line - the source line to be checked
* @param index - the 1-based index of the character to be checked
* @return true only if the character is not a whitespace character
*/
protected boolean isNotWhitespace(String line, int index) {
index in 1..line.size() && !Character.isWhitespace(line[index - 1] as char)
}
protected boolean isNotCharacter(String line, char c, int index) {
index in 1..line.size() && line[index - 1] as char != c
}
protected int indexOfClosingBrace(String line, int blockLastColumn) {
int index = blockLastColumn - 2
while(index >= 0) {
if (line[index] == '}') {
return index
}
index--
}
return index
}
}