Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * fb-contrib - Auxiliary detectors for Java programs
   * Copyright (C) 2005-2013 Dave Brosius
   * 
   * 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 com.mebigfatguy.fbcontrib.detect;
 
 import java.util.Map;
 import java.util.Set;
 
 import  org.apache.bcel.Repository;
 import  org.apache.bcel.classfile.Code;
 import  org.apache.bcel.classfile.JavaClass;
 import  org.apache.bcel.classfile.Method;
 import  org.apache.bcel.generic.Type;
 
 
 import  edu.umd.cs.findbugs.BugInstance;
 import  edu.umd.cs.findbugs.BugReporter;
 import  edu.umd.cs.findbugs.BytecodeScanningDetector;
 import  edu.umd.cs.findbugs.OpcodeStack;
 import  edu.umd.cs.findbugs.ba.ClassContext;

looks for methods that return a parameter after making what looks like modifications to that parameter. This leads to confusion for the user of this method as it isn't obvious that the 'original' object is modified. If the point of this method is to modify the parameter, it is probably better just to have the method be a void method, to avoid confusion.
 
 public class ConfusingFunctionSemantics extends BytecodeScanningDetector 
 {
 	private static final Set<StringknownImmutables = new HashSet<String>();
 	static {
 		.add("Ljava/lang/String;");
 		.add("Ljava/lang/Byte;");
 		.add("Ljava/lang/Character;");
 		.add("Ljava/lang/Short;");
 		.add("Ljava/lang/Integer;");
 		.add("Ljava/lang/Long;");
 		.add("Ljava/lang/Float;");
 		.add("Ljava/lang/Double;");
 		.add("Ljava/lang/Boolean;");
 		.add("Ljava/lang/Class;");
 	}
 	
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;

constructs a CFS detector given the reporter to report bugs on

Parameters:
bugReporter the sync of bug reports
 
 	public ConfusingFunctionSemantics(BugReporter bugReporter) {
 		this. = bugReporter;
 	}

implements the visitor to initialize/destroy the possible parameter registers and opcode stack

Parameters:
classContext the context object of the currently parsed class
 
 	public void visitClassContext(ClassContext classContext) {
 		try {
 			 = new OpcodeStack();
 			super.visitClassContext(classContext);
 		} finally {
 			 = null;
 			 = null;
 		}
 	}

implements the visitor to look for any non-immutable typed parameters are assignable to the return type. If found, the method is parsed.

Parameters:
obj the context object of the currently parsed code block
 
 	public void visitCode(Code obj) {
 		try {
 			Method m = getMethod();
			String methodSignature = m.getSignature();
			String retSignature = Type.getReturnType(methodSignature).getSignature();
			JavaClass returnClass = null;
			int[] parmRegs = null;
			if ((retSignature.charAt(0) == 'L') && !.contains(retSignature)) {
				Type[] parmTypes = Type.getArgumentTypes(methodSignature);
				for (int p = 0; p < parmTypes.length; p++) {
					String parmSignature = parmTypes[p].getSignature();
					if ((parmSignature.charAt(0) == 'L') && !.contains(parmSignature)) {
						if (returnClass == null) {
							returnClass = Repository.lookupClass(retSignature.substring(1, retSignature.length() - 1));
							parmRegs = RegisterUtils.getParameterRegisters(m);
						}
						JavaClass parmClass = Repository.lookupClass(parmSignature.substring(1, parmSignature.length() - 1));
						if ((parmRegs != null) && parmClass.instanceOf(returnClass)) {
							.put(Integer.valueOf(parmRegs[p]), new ParmUsage());
						}
					}
				}
				if (.size() > 0) {
					.resetForMethodEntry(this);
					super.visitCode(obj);
					for (ParmUsage pu : .values()) {
						if ((pu.returnPC >= 0) && (pu.alteredPC >= 0)) {
							.reportBug(new BugInstance(this"CFS_CONFUSING_FUNCTION_SEMANTICS", NORMAL_PRIORITY)
										.addClass(this)
										.addMethod(this)
										.addSourceLine(thispu.returnPC)
										.addSourceLine(thispu.alteredPC));
						}
					}
				}
			}
catch (ClassNotFoundException cnfe) {
			.reportMissingClass(cnfe);
		}
	}
	public void sawOpcode(int seen) {
			return;
		try {
			if (seen == ARETURN) {
				if (.getStackDepth() > 0) {
					OpcodeStack.Item item = .getStackItem(0);
					int reg = item.getRegisterNumber();
					ParmUsage pu = .get(Integer.valueOf(reg));
					if (pu != null)
				}
else if (seen == PUTFIELD) {
				if (.getStackDepth() > 1) {
					OpcodeStack.Item item = .getStackItem(1);
					int reg = item.getRegisterNumber();
					ParmUsage pu = .get(Integer.valueOf(reg));
					if (pu != null)
				}
else if ((seen == ASTORE) || ((seen >= ASTORE_0) && (seen <= ASTORE_3))) {
				int reg = RegisterUtils.getAStoreReg(thisseen);
else if ((seen == INVOKEVIRTUAL) || (seen == INVOKEINTERFACE)) {
				String calledSig = getSigConstantOperand();
				String calledRet = Type.getReturnType(calledSig).getSignature();
				if ("V".equals(calledRet)) {
					int calledObjOffset = Type.getArgumentTypes(calledSig).length;
					if (.getStackDepth() > calledObjOffset) {
						OpcodeStack.Item item = .getStackItem(calledObjOffset);
						int reg = item.getRegisterNumber();
						ParmUsage pu = .get(Integer.valueOf(reg));
						if (pu != null)
					}
				}
			}
finally {
			.sawOpcode(thisseen);
		}
	}
	static class ParmUsage
	{
		int returnPC = -1;
		int alteredPC = -1;
		public void setReturnPC(int pc) {
			 = pc;
		}
		public void setAlteredPC(int pc) {
			if ( < 0)
				 = pc;
		}
	}
New to GrepCode? Check out our FAQ X