FindPuzzlers.java
| Index Score | ||
|---|---|---|
 |
 |
edu.umd.cs.findbugs.detect |
 |
 |
FindBugs |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| COMPARISONS | Number of comparison operators |  |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| JAVA0266 | JAVA0266 Use of System.out | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| LOC | Lines of code | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| BLOCKS | Number of blocks | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0119 | JAVA0119 Control variable changed within body of for loop | |
| EXEC_COMMENTS | Comments in executable code | |
| NEST_DEPTH | Maximum nesting depth | |
| LOGICAL_LINES | Number of statements | |
| LINE_COMMENT | Number of line comments | |
| JAVA0076 | JAVA0076 Use of magic number | |
| LINES | Number of lines in the source file | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| COMMENTS | Comment lines | |
| FUNCTIONS | Number of function declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| LOOPS | Number of loops | |
| PARAMS | Number of formal parameter declarations | |
/*
* FindBugs - Find bugs in Java programs
* Copyright (C) 2005, University of Maryland
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs.detect;
import java.util.ArrayList;
import java.util.Collection;
import org.apache.bcel.Repository;
import org.apache.bcel.classfile.Code;
import org.apache.bcel.classfile.Constant;
import org.apache.bcel.classfile.ConstantString;
import org.apache.bcel.classfile.JavaClass;
import edu.umd.cs.findbugs.BugAccumulator;
import edu.umd.cs.findbugs.BugAnnotation;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.IntAnnotation;
import edu.umd.cs.findbugs.LocalVariableAnnotation;
import edu.umd.cs.findbugs.OpcodeStack;
import edu.umd.cs.findbugs.Priorities;
import edu.umd.cs.findbugs.SourceLineAnnotation;
import edu.umd.cs.findbugs.SystemProperties;
import edu.umd.cs.findbugs.OpcodeStack.Item;
import edu.umd.cs.findbugs.ba.AnalysisContext;
import edu.umd.cs.findbugs.ba.XFactory;
import edu.umd.cs.findbugs.ba.XMethod;
import edu.umd.cs.findbugs.bcel.OpcodeStackDetector;
import edu.umd.cs.findbugs.visitclass.Util;
public class FindPuzzlers extends OpcodeStackDetector {
private static final boolean VAMISMATCH_DEBUG = SystemProperties.getBoolean("vamismatch.debug");
final BugReporter bugReporter;
final BugAccumulator bugAccumulator;
public FindPuzzlers(BugReporter bugReporter) {
this.bugReporter = bugReporter;
this.bugAccumulator = new BugAccumulator(bugReporter);
}
@Override
public void visit(Code obj) {
prevOpcodeIncrementedRegister = -1;
best_priority_for_ICAST_INTEGER_MULTIPLY_CAST_TO_LONG = LOW_PRIORITY+1;
prevOpCode = NOP;
previousMethodInvocation = null;
badlyComputingOddState = 0;
resetIMulCastLong();
imul_distance = 10000;
ternaryConversionState = 0;
super.visit(obj);
bugAccumulator.reportAccumulatedBugs();
}
int imul_constant;
int imul_distance;
boolean imul_operand_is_parameter;
int prevOpcodeIncrementedRegister;
int valueOfConstantArgumentToShift;
int best_priority_for_ICAST_INTEGER_MULTIPLY_CAST_TO_LONG ;
boolean constantArgumentToShift;
boolean shiftOfNonnegativeValue;
int ternaryConversionState = 0;
int badlyComputingOddState;
int prevOpCode;
XMethod previousMethodInvocation;
boolean isTigerOrHigher;
private static final int FS_STATE_NONE = 0;
private static final int FS_STATE_SAW_STR_LOAD = 1;
private static final int FS_STATE_SAW_CONST_PUSH = 2;
private static final int FS_STATE_SAW_NEWARRAY = 3;
private int prevConst = -1;
private int fsState = FS_STATE_NONE;
private int fsAAStores = 0;
private String fsFmtStr = null;
@Override
public void visit(JavaClass obj) {
isTigerOrHigher = obj.getMajor() >= MAJOR_1_5;
}
private void resetIMulCastLong() {
imul_constant = 1;
imul_operand_is_parameter = false;
}
private int adjustPriority(int factor, int priority) {
if (factor <= 4) return LOW_PRIORITY+2;
if (factor <= 10000) return priority+1;
if (factor <= 60*60*1000) return priority;
return priority-1;
}
private int adjustMultiplier(Object constant, int mul) {
if (!(constant instanceof Integer)) return mul;
return Math.abs(((Integer) constant).intValue()) * mul;
}
@Override
public void sawOpcode(int seen) {
if (seen != RETURN && isReturn(seen) && isRegisterStore(getPrevOpcode(1))) {
int priority = Priorities.NORMAL_PRIORITY;
if (getMethodSig().endsWith(")Z")) priority = Priorities.HIGH_PRIORITY;
else {
if (getMethodSig().endsWith(")Ljava/lang/String;")) priority = Priorities.LOW_PRIORITY;
if (getPC() == getCode().getCode().length-1 ) priority++;
}
bugReporter.reportBug(new BugInstance(this, "DLS_DEAD_LOCAL_STORE_IN_RETURN", priority).addClassAndMethod(this).addSourceLine(this));
}
// System.out.println(getPC() + " " + OPCODE_NAMES[seen] + " " + ternaryConversionState);
if (seen == IMUL) {
if (imul_distance != 1) resetIMulCastLong();
imul_distance = 0;
if (stack.getStackDepth() > 1) {
OpcodeStack.Item item0 = stack.getStackItem(0);
OpcodeStack.Item item1 = stack.getStackItem(1);
imul_constant = adjustMultiplier(item0.getConstant(), imul_constant);
imul_constant = adjustMultiplier(item1.getConstant(), imul_constant);
if (item0.isInitialParameter() || item1.isInitialParameter())
imul_operand_is_parameter = true;
}} else {
imul_distance++;
}
if (prevOpCode == IMUL && seen == I2L) {
int priority = adjustPriority(imul_constant, NORMAL_PRIORITY);
if (priority >= LOW_PRIORITY && imul_constant != 1000 && imul_operand_is_parameter) priority = NORMAL_PRIORITY;
if (priority <= best_priority_for_ICAST_INTEGER_MULTIPLY_CAST_TO_LONG) {
best_priority_for_ICAST_INTEGER_MULTIPLY_CAST_TO_LONG = priority;
bugAccumulator.accumulateBug(new BugInstance(this,
"ICAST_INTEGER_MULTIPLY_CAST_TO_LONG",
priority)
.addClassAndMethod(this), this);
}
}
if (getMethodName().equals("<clinit>") && (seen == PUTSTATIC || seen == GETSTATIC || seen == INVOKESTATIC)) {
String clazz = getClassConstantOperand();
if (!clazz.equals(getClassName())) {
try {
JavaClass targetClass = Repository.lookupClass(clazz);
if (Repository.instanceOf(targetClass, getThisClass())) {
int priority = NORMAL_PRIORITY;
if (seen == GETSTATIC) priority--;
if (!targetClass.isPublic()) priority++;
bugAccumulator.accumulateBug(new BugInstance(this,
"IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION",
priority)
.addClassAndMethod(this).addClass(getDottedClassConstantOperand()),
this);
}
} catch (ClassNotFoundException e) {
// ignore it
}
}
}
if (false && (seen == INVOKEVIRTUAL)
&& getNameConstantOperand().equals("equals")
&& getSigConstantOperand().equals("(Ljava/lang/Object;)Z")
&& stack.getStackDepth() > 1) {
OpcodeStack.Item item0 = stack.getStackItem(0);
OpcodeStack.Item item1 = stack.getStackItem(1);
if (item0.isArray() || item1.isArray()) {
bugAccumulator.accumulateBug(new BugInstance("EC_BAD_ARRAY_COMPARE", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
}
}
if (seen >= IALOAD && seen <= SALOAD || seen >= IASTORE && seen <= SASTORE ) {
Item index = stack.getStackItem(0);
if (index.getSpecialKind() == Item.AVERAGE_COMPUTED_USING_DIVISION) {
SourceLineAnnotation where;
if (index.getPC() >= 0)
where = SourceLineAnnotation.fromVisitedInstruction(this, index.getPC());
else where = SourceLineAnnotation.fromVisitedInstruction(this);
bugAccumulator.accumulateBug(new BugInstance(this, "IM_AVERAGE_COMPUTATION_COULD_OVERFLOW", NORMAL_PRIORITY)
.addClassAndMethod(this), where);
}
}
if ((seen == IFEQ || seen == IFNE) && getPrevOpcode(1) == IMUL
&& ( getPrevOpcode(2) == SIPUSH
|| getPrevOpcode(2) == BIPUSH
)
&& getPrevOpcode(3) == IREM
)
bugAccumulator.accumulateBug(new BugInstance(this, "IM_MULTIPLYING_RESULT_OF_IREM", LOW_PRIORITY)
.addClassAndMethod(this), this);
if (seen == I2S && getPrevOpcode(1) == IUSHR && !shiftOfNonnegativeValue &&
(!constantArgumentToShift || valueOfConstantArgumentToShift % 16 != 0)
|| seen == I2B && getPrevOpcode(1) == IUSHR && !shiftOfNonnegativeValue
&& (!constantArgumentToShift || valueOfConstantArgumentToShift % 8 != 0))
bugAccumulator.accumulateBug(new BugInstance(this, "ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
constantArgumentToShift = false;
shiftOfNonnegativeValue = false;
if ( (seen == IUSHR
|| seen == ISHR
|| seen == ISHL )) {
if (stack.getStackDepth() <= 1) {
// don't understand; lie so other detectors won't get concerned
constantArgumentToShift = true;
valueOfConstantArgumentToShift = 8;
}
else {
Object rightHandSide
= stack.getStackItem(0).getConstant();
Object leftHandSide
= stack.getStackItem(1).getConstant();
shiftOfNonnegativeValue = stack.getStackItem(1).isNonNegative();
if (rightHandSide instanceof Integer) {
constantArgumentToShift = true;
valueOfConstantArgumentToShift = ((Integer) rightHandSide);
if (valueOfConstantArgumentToShift < 0 || valueOfConstantArgumentToShift >= 32)
bugAccumulator.accumulateBug(new BugInstance(this, "ICAST_BAD_SHIFT_AMOUNT",
valueOfConstantArgumentToShift < 0 ? LOW_PRIORITY : HIGH_PRIORITY)
.addClassAndMethod(this)
.addInt(valueOfConstantArgumentToShift).describe(IntAnnotation.INT_SHIFT), this);
}
if (leftHandSide != null
&& leftHandSide instanceof Integer
&& ((Integer) leftHandSide)
> 0) {
// boring; lie so other detectors won't get concerned
constantArgumentToShift = true;
valueOfConstantArgumentToShift = 8;
}
}
}
if (seen == INVOKEVIRTUAL && stack.getStackDepth() > 0
&& getClassConstantOperand().equals("java/util/Date")
&& getNameConstantOperand().equals("setMonth")
&& getSigConstantOperand().equals("(I)V")) {
OpcodeStack.Item item = stack.getStackItem(0);
Object o = item.getConstant();
if (o != null && o instanceof Integer) {
int v = (Integer) o;
if (v < 0 || v > 11)
bugReporter.reportBug(new BugInstance(this, "DMI_BAD_MONTH", HIGH_PRIORITY)
.addClassAndMethod(this)
.addInt(v).describe(IntAnnotation.INT_VALUE)
.addCalledMethod(this)
.addSourceLine(this)
);
}
}
if (seen == INVOKEVIRTUAL && stack.getStackDepth() > 1
&& getClassConstantOperand().equals("java/util/Calendar")
&& getNameConstantOperand().equals("set")
||
seen == INVOKESPECIAL && stack.getStackDepth() > 1
&& getClassConstantOperand().equals("java/util/GregorianCalendar")
&& getNameConstantOperand().equals("<init>")
) {
String sig = getSigConstantOperand();
if (sig.startsWith("(III")) {
int pos = sig.length() - 5;
OpcodeStack.Item item = stack.getStackItem(pos);
Object o = item.getConstant();
if (o != null && o instanceof Integer) {
int v = (Integer) o;
if (v < 0 || v > 11)
bugReporter.reportBug(new BugInstance(this, "DMI_BAD_MONTH", NORMAL_PRIORITY)
.addClassAndMethod(this)
.addInt(v).describe(IntAnnotation.INT_VALUE)
.addCalledMethod(this)
.addSourceLine(this)
);
}
}
}
if (isRegisterStore() && (seen == ISTORE
|| seen == ISTORE_0
|| seen == ISTORE_1
|| seen == ISTORE_2
|| seen == ISTORE_3)
&& getRegisterOperand() == prevOpcodeIncrementedRegister) {
bugAccumulator.accumulateBug(new BugInstance(this, "DLS_OVERWRITTEN_INCREMENT", HIGH_PRIORITY)
.addClassAndMethod(this), this);
}
if (seen == IINC) {
prevOpcodeIncrementedRegister = getRegisterOperand();
}
else
prevOpcodeIncrementedRegister = -1;
// Java Puzzlers, Chapter 2, puzzle 1
// Look for ICONST_2 IREM ICONST_1 IF_ICMPNE L1
switch (badlyComputingOddState) {
case 0:
if (seen == ICONST_2) badlyComputingOddState++;
break;
case 1:
if (seen == IREM) {
OpcodeStack.Item item = stack.getStackItem(1);
if (!item.isNonNegative() && item.getSpecialKind() != OpcodeStack.Item.MATH_ABS)
badlyComputingOddState++;
else badlyComputingOddState = 0;
}
else badlyComputingOddState = 0;
break;
case 2:
if (seen == ICONST_1) badlyComputingOddState++;
else badlyComputingOddState = 0;
break;
case 3:
if (seen == IF_ICMPEQ || seen == IF_ICMPNE) {
bugAccumulator.accumulateBug(new BugInstance(this, "IM_BAD_CHECK_FOR_ODD", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
}
badlyComputingOddState = 0;
break;
}
// Java Puzzlers, chapter 3, puzzle 12
if (seen == INVOKEVIRTUAL && stack.getStackDepth() > 0
&& (getNameConstantOperand().equals("toString")
&& getSigConstantOperand().equals("()Ljava/lang/String;")
|| getNameConstantOperand().equals("append")
&& getSigConstantOperand().equals("(Ljava/lang/Object;)Ljava/lang/StringBuilder;") && getClassConstantOperand().equals("java/lang/StringBuilder")
|| getNameConstantOperand().equals("append")
&& getSigConstantOperand().equals("(Ljava/lang/Object;)Ljava/lang/StringBuffer;") && getClassConstantOperand().equals("java/lang/StringBuffer")
)
) {
OpcodeStack.Item item = stack.getStackItem(0);
String signature = item.getSignature();
if (signature != null && signature.startsWith("[")) {
String name = null;
int reg = item.getRegisterNumber();
Collection<BugAnnotation> as = new ArrayList<BugAnnotation>();
if(reg != -1) {
LocalVariableAnnotation lva =
LocalVariableAnnotation.getLocalVariableAnnotation(
getMethod(), reg, getPC(), getPC()-1);
name = "array " + lva.getName() + "[]";
as.add(lva);
}
if(name != null) {
bugAccumulator.accumulateBug(
new BugInstance(this, "DMI_INVOKING_TOSTRING_ON_ARRAY", NORMAL_PRIORITY)
.addClassAndMethod(this)
.addAnnotations(as), this);
} else {
bugAccumulator.accumulateBug(
new BugInstance(this, "DMI_INVOKING_TOSTRING_ON_ANONYMOUS_ARRAY", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
}
}
}
if (isTigerOrHigher) {
if (previousMethodInvocation != null && prevOpCode == INVOKESPECIAL && seen == INVOKEVIRTUAL) {
String classNameForPreviousMethod = previousMethodInvocation.getClassName();
String classNameForThisMethod = getClassConstantOperand();
if (classNameForPreviousMethod.startsWith("java.lang.")
&& classNameForPreviousMethod.equals(classNameForThisMethod.replace('/','.'))
&& getNameConstantOperand().endsWith("Value")
&& getSigConstantOperand().length() == 3) {
if (getSigConstantOperand().charAt(2) == previousMethodInvocation.getSignature().charAt(1))
bugAccumulator.accumulateBug(new BugInstance(this, "BX_BOXING_IMMEDIATELY_UNBOXED", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
else
bugAccumulator.accumulateBug(new BugInstance(this, "BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
ternaryConversionState = 1;
} else ternaryConversionState = 0;
} else if (seen == INVOKEVIRTUAL) {
if (getClassConstantOperand().startsWith("java/lang") && getNameConstantOperand().endsWith("Value") && getSigConstantOperand().length() == 3)
ternaryConversionState = 1;
else ternaryConversionState = 0;
}else if (ternaryConversionState == 1) {
if (I2L <= seen && seen <= I2S)
ternaryConversionState = 2;
else ternaryConversionState = 0;
}
else if (ternaryConversionState == 2) {
ternaryConversionState = 0;
if (seen == GOTO)
bugReporter.reportBug(new BugInstance(this, "BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR", NORMAL_PRIORITY)
.addClassAndMethod(this)
.addSourceLine(this));
}
}
if (seen == INVOKESTATIC)
if ((getNameConstantOperand().startsWith("assert") || getNameConstantOperand().startsWith("fail")) && getMethodName().equals("run")
&& implementsRunnable(getThisClass())) {
try {
int size1 = Util.getSizeOfSurroundingTryBlock(getConstantPool(), getMethod().getCode(),
"java/lang/Throwable", getPC());
int size2 = Util.getSizeOfSurroundingTryBlock(getConstantPool(), getMethod().getCode(),
"java/lang/Error", getPC());
int size3 = Util.getSizeOfSurroundingTryBlock(getConstantPool(), getMethod().getCode(),
"java/lang/AssertionFailureError", getPC());
int size = Math.min(Math.min( size1, size2), size3);
if (size == Integer.MAX_VALUE) {
JavaClass targetClass = AnalysisContext.currentAnalysisContext().lookupClass(getClassConstantOperand().replace('/', '.'));
if (targetClass.getSuperclassName().startsWith("junit")) {
bugAccumulator.accumulateBug(new BugInstance(this, "IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD", NORMAL_PRIORITY)
.addClassAndMethod(this), this);
}
}
} catch (ClassNotFoundException e) {
AnalysisContext.reportMissingClass(e);
}
}
if (seen == INVOKESPECIAL && getClassConstantOperand().startsWith("java/lang/") && getNameConstantOperand().equals("<init>")
&& getSigConstantOperand().length() == 4
)
previousMethodInvocation = XFactory.createReferencedXMethod(this);
else if (seen == INVOKESTATIC && getClassConstantOperand().startsWith("java/lang/")
&& getNameConstantOperand().equals("valueOf")
&& getSigConstantOperand().length() == 4)
previousMethodInvocation = XFactory.createReferencedXMethod(this);
else previousMethodInvocation = null;
prevOpCode = seen;
// Check for PrintStream.printf, PrintStream.format, String.format,
// Formatter.format
if(fsState == FS_STATE_NONE) {
if((seen == LDC) || (seen == LDC_W)) {
Constant c = getConstantRefOperand();
if (c instanceof ConstantString) {
fsFmtStr = getStringConstantOperand();
if(VAMISMATCH_DEBUG) {
System.out.println("Format str: " + fsFmtStr);
}
fsState = FS_STATE_SAW_STR_LOAD;
}
}
}
else if(fsState == FS_STATE_SAW_STR_LOAD) {
if(seen == ICONST_0) {
prevConst = 0; fsState = FS_STATE_SAW_CONST_PUSH;
} else if(seen == ICONST_1) {
prevConst = 1; fsState = FS_STATE_SAW_CONST_PUSH;
} else if(seen == ICONST_2) {
prevConst = 2; fsState = FS_STATE_SAW_CONST_PUSH;
} else if(seen == ICONST_3) {
prevConst = 3; fsState = FS_STATE_SAW_CONST_PUSH;
} else if(seen == ICONST_4) {
prevConst = 4; fsState = FS_STATE_SAW_CONST_PUSH;
} else if(seen == ICONST_5) {
prevConst = 5; fsState = FS_STATE_SAW_CONST_PUSH;
} else if(seen == BIPUSH) {
prevConst = getIntConstant();
fsState = FS_STATE_SAW_CONST_PUSH;
} else {
prevConst = -1;
fsState = FS_STATE_NONE;
}
}
else if(fsState == FS_STATE_SAW_CONST_PUSH) {
if(seen == ANEWARRAY) {
if(VAMISMATCH_DEBUG) {
System.out.println("New array with const: " + prevConst);
}
fsState = FS_STATE_SAW_NEWARRAY;
fsAAStores = 0;
} else {
fsState = FS_STATE_NONE;
}
}
else if(fsState == FS_STATE_SAW_NEWARRAY) {
if(seen == AASTORE) {
fsAAStores++;
if(VAMISMATCH_DEBUG) {
System.out.println("Saw an AASTORE; new count: " + fsAAStores);
}
if(fsAAStores > prevConst) {
// Stored too many array elements!
if(VAMISMATCH_DEBUG) {
System.out.println("Oops, " + fsAAStores + " is too many");
}
fsState = FS_STATE_NONE;
}
}
else if(
fsAAStores == prevConst &&
(seen == INVOKESPECIAL ||
seen == INVOKEVIRTUAL ||
seen == INVOKESTATIC))
{
String cl = getClassConstantOperand();
String nm = getNameConstantOperand();
XMethod xm = XFactory.createReferencedXMethod(this);
int flags = xm.getAccessFlags();
if((flags & ACC_TRANSIENT) != 0) {
if(VAMISMATCH_DEBUG) {
System.out.println("Found VARARGS method: " + cl + "." + nm);
}
if("java/util/Formatter".equals(cl) && "format".equals(nm) ||
"java/lang/String".equals(cl) && "format".equals(nm) ||
"java/io/PrintStream".equals(cl) && "format".equals(nm) ||
"java/io/PrintStream".equals(cl) && "printf".equals(nm))
{
// Get the format string if possible
int pcts = 0; // number of normally consumed args
int highAbs = 0; // highest indexed arg
for(int i = 0; i < fsFmtStr.length(); i++) {
if(fsFmtStr.charAt(i) == '%') {
if(i < fsFmtStr.length()-1 &&
// If next char is '%', then it's just
// an escaped percent. If next char is
// 'n', then it's just the platform-
// specific line separator. In neither
// case is an argument consumed.
(fsFmtStr.charAt(i+1) == '%' ||
fsFmtStr.charAt(i+1) == 'n'))
{
i++; // skip over
}
else if(i < fsFmtStr.length()-1 &&
fsFmtStr.charAt(i+1) == '<')
{
// this just refers to whatever the
// previous placeholder referred to
i++; // skip over
}
else if(i < fsFmtStr.length()-1 &&
fsFmtStr.charAt(i+1) >= '0' &&
fsFmtStr.charAt(i+1) <= '9')
{
int idx = fsFmtStr.charAt(i+1) - '0';
i++;
// Parse index into idx
while(i+1 < fsFmtStr.length()) {
if(fsFmtStr.charAt(i+1) >= '0' &&
fsFmtStr.charAt(i+1) <= '9')
{
idx *= 10;
idx += fsFmtStr.charAt(i+1) - '0';
}
else {
if(fsFmtStr.charAt(i+1) != '$') {
// oops, can't parse
// this as an absolute
idx = 0; pcts++;
}
break;
}
i++;
}
// This is the highest absolute
// index used so far
if(idx > highAbs) {
if(VAMISMATCH_DEBUG) {
System.out.println("New highest abs idx: " + idx);
}
highAbs = idx;
} else {
if(VAMISMATCH_DEBUG) {
System.out.println("Not highest abs idx: " + idx + " (highest: " + highAbs + ")");
}
}
}
else {
pcts++;
}
}
}
int consumedPcts = Math.max(pcts, highAbs);
if(VAMISMATCH_DEBUG) {
System.out.println(
"Consumed pcts is: " + consumedPcts +
", normal pcts: " + pcts +
", highest absolute: " + highAbs);
}
if(consumedPcts != prevConst) {
// Bug!
bugReporter.reportBug(
new BugInstance(this, "VA_FORMAT_STRING_ARG_MISMATCH", NORMAL_PRIORITY)
.addClassAndMethod(this)
.addCalledMethod(this)
.addString(fsFmtStr)
.addInt(consumedPcts).describe(IntAnnotation.INT_EXPECTED_ARGUMENTS)
.addInt(prevConst).describe(IntAnnotation.INT_ACTUAL_ARGUMENTS)
.addSourceLine(this)
);
if(VAMISMATCH_DEBUG) {
System.out.println(
"WARNING: # consumed percent signs (" +
consumedPcts +
") doesn't match vararg array size: " +
prevConst);
}
} else {
// OK
if(VAMISMATCH_DEBUG) {
System.out.println(
"# consumed percent signs (" +
consumedPcts +
") matchs vararg array size: " +
prevConst);
}
}
}
else {
// OK
if(VAMISMATCH_DEBUG) {
System.out.println("Not a VARARGS I'm familiar with");
}
}
}
else {
if("java/util/Formatter".equals(cl) && "format".equals(nm) ||
"java/lang/String".equals(cl) && "format".equals(nm) ||
"java/io/PrintStream".equals(cl) && "format".equals(nm) ||
"java/io/PrintStream".equals(cl) && "printf".equals(nm))
{
// OK
if(VAMISMATCH_DEBUG) {
System.out.println("Oops: " + cl + "." + nm + " not a VARARGS");
}
}
}
fsState = FS_STATE_NONE;
}
}
}
boolean implementsRunnable(JavaClass obj) {
if (obj.getSuperclassName().equals("java.lang.Thread")) return true;
for(String s : obj.getInterfaceNames())
if (s.equals("java.lang.Runnable")) return true;
return false;
}
}
The table below shows all metrics for FindPuzzlers.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 104.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 45.00 | Comment lines | |
| COMMENT_DENSITY | 0.09 | Comment density | |
| COMPARISONS | 206.00 | Number of comparison operators | |
| CYCLOMATIC | 225.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 1.00 | Comments in declarations | |
| DOC_COMMENT | 0.00 | Number of javadoc comment lines | |
| ELOC | 478.00 | Effective lines of code | |
| EXEC_COMMENTS | 18.00 | Comments in executable code | |
| EXITS | 79.00 | Procedure exits | |
| FUNCTIONS | 8.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 109.55 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 23.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 40.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 6.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 1.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 11.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 4.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 3.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 9.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 2604.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 12.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 685.00 | Number of lines in the source file | |
| LINE_COMMENT | 27.00 | Number of line comments | |
| LOC | 577.00 | Lines of code | |
| LOGICAL_LINES | 235.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 11.00 | Maximum nesting depth | |
| OPERANDS | 1403.00 | Number of operands | |
| OPERATORS | 2679.00 | Number of operators | |
| PARAMS | 9.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4082.00 | Halstead program length | |
| PROGRAM_VOCAB | 422.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 14.00 | Number of return points from functions | |
| SIZE | 24114.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 365.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 63.00 | Number of whitespace lines | |