org.codenarc.util.gosu.GosuUtil.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gs-codenarc-ext Show documentation
Show all versions of gs-codenarc-ext Show documentation
A CodeNarc extension library for gosu.
/*
* Copyright 2010 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.util.gosu
import org.codenarc.source.SourceCode
/**
* Contains static utility methods related to the text processing of Gosu code.
* This is an internal class and its API is subject to change.
*/
class GosuUtil {
private static def functionCache = [:]
public static void clearCache() {
functionCache.clear()
}
/**
* Check if string is commented
* @param textLine
* @return true if in line commented
*/
public static boolean isInlineCommented(String textLine) {
return textLine.trim() ==~ /\/\/.*$/ || textLine.trim() ==~ /\/\*([^*]|[\r\n]|(\*+([^*\/]|[\r\n])))*\*+\//
}
/**
* Check if string is a blank line
* @param textLine
* @return true if a blank line
*/
public static boolean isBlankLine(String textLine) {
return textLine ==~ /^\s*$/
}
/**
* Check for the start of a block comment
* @param textLine
* @return true if the start of a block comment
*/
public static boolean isStartOfBlockComment(String textLine) {
return textLine.trim() ==~ /\/\*.*$/
}
/**
* Check for the end of a block comment
* @param textLine
* @return true if the end of a block comment
*/
public static boolean isEndOfBlockComment(String textLine) {
return textLine.trim() =~ /\*\/.*$/
}
/**
* Check if string has a Java style line ending
* @param textLine
* @return true if line ends with java style line ending
*/
public static boolean isJavaStyleLineEnding(String textLine) {
return textLine.trim().endsWith(";")
}
/**
* Check for the start of a .*/
}
/**
* Check for the end of a getFunctionParameters(GosuCodeBlockWrapper functionWrapper) {
List parametersWithType;
String functionSignature = ""
Iterator it = functionWrapper.lines.iterator()
while(it.hasNext()) {
String currentLine = it.next()
if (currentLine.contains("(") && currentLine.contains(")")) {
functionSignature = currentLine.substring(currentLine.indexOf("(") + 1, currentLine.lastIndexOf(")")).trim()
break
}
if (currentLine.contains("(")) {
functionSignature = currentLine.substring(currentLine.indexOf("(") + 1).trim()
continue
}
if (currentLine.contains(")")) {
functionSignature += " " + currentLine.substring(0, currentLine.lastIndexOf(")")).trim()
break
}
functionSignature += " " + currentLine.trim()
}
// TODO FIXME Need to split by , where it is not within ( ) to handle blocks
parametersWithType = functionSignature.split(",")
return parametersWithType
}
/**
* Returns a boolean indicating if the parameter is used within the function
* @param parameter, functionWrapper
* @return a boolean indicating if the parameter is used
*/
public static boolean isParameterUsedWithinFunction(String parameter, GosuCodeBlockWrapper functionWrapper) {
int numberOfTimesParameterUsed = 0
functionWrapper.lines.each() { line ->
String loc = ((String) line).trim()
if (loc =~ /\b$parameter\b/ ) {
numberOfTimesParameterUsed++
}
}
return (numberOfTimesParameterUsed > 1)
}
public static boolean isInterface(SourceCode sourceCode) {
return GosuUtil.getClassDefinition(sourceCode).contains("interface ")
}
public static String getClassDefinition(SourceCode sourceCode) {
StringBuilder classDef = new StringBuilder()
boolean inComment = false, inDef = false
sourceCode.getLines().each() { obj ->
// attempting to short circuit all this once we have the class def line(s)
if (classDef.length() == 0 || inDef) {
String line = ((String) obj).trim()
if (GosuUtil.isStartOfBlockComment(line)) {
inComment = true
}
if (!(inComment || GosuUtil.isInlineCommented(line))
&& line =~ /(public )?(abstract )?(class|interface).*/) {
inDef = true
}
if (inDef) {
classDef.append(line + " ")
}
if (line.contains("{")) {
inDef = false
}
if (GosuUtil.isEndOfBlockComment(line)) {
inComment = false
}
}
}
return classDef.toString().replace("{", "").trim()
}
}