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  org.apache.bcel.Repository;
 import  org.apache.bcel.classfile.Code;
 import  org.apache.bcel.classfile.JavaClass;
 
 
 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;
 import  edu.umd.cs.findbugs.ba.XField;

looks for loops that transfers the contents of one collection to another. These collection sources might be local variables or member fields, including sets, maps key/values, lists, or arrays. It is simpler to just use the addAll method of the collection class. In the case where the source is an array, you can use Arrays.asList(array), and use that as the source to addAll.
 
 public class UseAddAll extends BytecodeScanningDetector {
 	private JavaClass collectionClass;
 	private final BugReporter bugReporter;
 	private OpcodeStack stack;
register/field to alias register/field
 
 	private Map<Comparable<?>, Comparable<?>> userValues;
alias register to loop info
 
 	private Map<Comparable<?>, LoopInfoloops;
 	private boolean isInstanceMethod;

constructs a UTA detector given the reporter to report bugs on

Parameters:
bugReporter the sync of bug reports
 
 	public UseAddAll(BugReporter bugReporter) {
 		this. = bugReporter;
 		try {
 			 = Repository.lookupClass("java/util/Collection");
 		} catch (ClassNotFoundException cnfe) {
 			 = null;
 			 = cnfe;
 		}
 	}

implements the visitor to create and clear the stack, and report missing class errors

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

implements the visitor to reset the stack and userValues and loops

Parameters:
obj the context object of the currently parsed code block
 
 	public void visitCode(Code obj) {
		try {
			.resetForMethodEntry(this);
			 = new HashMap<Comparable<?>, LoopInfo>();
			 = !getMethod().isStatic();
			super.visitCode(obj);
finally {
			 = null;
			 = null;
		}
	}

implements the visitor to look for manually copying of collections to collections

Parameters:
seen the opcode of the currently parsed instruction
	public void sawOpcode(int seen) {
		Comparable<?> regOrField = null;
		Comparable<?> uValue;
		boolean sawAlias = false;
		boolean sawLoad = false;
		try {
			int pc = getPC();
			while (it.hasNext()) {
				LoopInfo loop = it.next();
				if ((loop.getEndPC()-3) <= pc) {
					int loopPC = loop.getAddPC();
					if (loopPC > 0) {
						.reportBug(new BugInstance(this"UAA_USE_ADD_ALL", NORMAL_PRIORITY)
								   .addClass(this)
								   .addMethod(this)
								   .addSourceLine(thisloopPC));
					}
					it.remove();
else if ((loop.getEndPC() > pc) && (loop.addPC < (pc - 5)) &&  (loop.addPC > 0)) {
					it.remove();
				}
			}
			if (seen == INVOKEINTERFACE) {
				String methodName = getNameConstantOperand();
				String signature = getSigConstantOperand();
				if ("get".equals(methodName) && "(I)Ljava/lang/Object;".equals(signature)) {
					if (.getStackDepth() > 1) {
						OpcodeStack.Item itm = .getStackItem(1);
						int reg = isLocalCollection(itm);
						if (reg >= 0) {
							regOrField = Integer.valueOf(reg);
							sawAlias = true;
else {
							String field = isFieldCollection(itm);
							if (field != null) {
								regOrField = field;
								sawAlias = true;
							}
						}
					}
else if ("keySet".equals(methodName) || "values".equals(methodName) || "iterator".equals(methodName) || "next".equals(methodName) || "hasNext".equals(methodName)) {
					if (.getStackDepth() > 0) {
						OpcodeStack.Item itm = .getStackItem(0);
						int reg = isLocalCollection(itm);
						if (reg >= 0) {
							regOrField = Integer.valueOf(reg);
							sawAlias = true;
else {
							String field = isFieldCollection(itm);
							if (field != null) {
								regOrField = field;
								sawAlias = true;
							}
						}
					}
else if ("add".equals(methodName) && "(Ljava/lang/Object;)Z".equals(signature)) {
					if (.getStackDepth() > 1) {
						OpcodeStack.Item colItem = .getStackItem(1);
						OpcodeStack.Item valueItem = .getStackItem(0);
						int reg = isLocalCollection(colItem);
						if (reg >= 0) {
							regOrField = Integer.valueOf(reg);
							uValue = (Comparable<?>)valueItem.getUserValue();
							if (uValue != null) {
								LoopInfo loop = .get(uValue);
								if (loop != null) {
									if (loop.isInLoop(pc)) {
										if (this.getCodeByte(getNextPC()) == POP) {
											loop.foundAdd(pc);
										}
									}
								}
							}
else {
							String field = isFieldCollection(colItem);
							if (field != null) {
								regOrField = field;
								uValue = (Comparable<?>)valueItem.getUserValue();
								if (uValue != null) {
									LoopInfo loop = .get(uValue);
									if (loop != null) {
										if (loop.isInLoop(pc)) {
											if (this.getCodeByte(getNextPC()) == POP) {
												loop.foundAdd(pc);
											}
										}
									}
								}
							}
						}
					}
				}
else if (((seen == ISTORE) || ((seen >= ISTORE_0) && (seen <= ISTORE_3)))
				   ||  ((seen == ASTORE) || ((seen >= ASTORE_0) && (seen <= ASTORE_3)))) {
				if (.getStackDepth() > 0) {
					uValue = (Comparable<?>).getStackItem(0).getUserValue();
					.put(Integer.valueOf(RegisterUtils.getStoreReg(thisseen)), uValue); 
				}
else if (((seen == ILOAD) || ((seen >= ILOAD_0) && (seen <= ILOAD_3)))
				   ||  ((seen == ALOAD) || ((seen >= ALOAD_0) && (seen <= ALOAD_3)))) {
				sawLoad = true;
else if (seen == IFEQ) {
				boolean loopFound = false;
				if (.getStackDepth() > 0) {
					if (getBranchOffset() > 0) {
						int gotoPos = getBranchTarget() - 3;
						byte[] code = getCode().getCode();
						if ((0x00FF & code[gotoPos]) == GOTO) {
							short brOffset = (short)(0x0FF & code[gotoPos+1]);
							brOffset <<= 8;
							brOffset |= (0x0FF & code[gotoPos+2]);
							gotoPos += brOffset;
							if (gotoPos < pc) {
								OpcodeStack.Item itm = .getStackItem(0);
								uValue = (Comparable<?>)itm.getUserValue();
								if (uValue != null) {
									.put(uValuenew LoopInfo(pcgetBranchTarget()));
								}
								loopFound = true;
							}
						}
						if (!loopFound) {
						}
					}
				}
else if ( && (seen == PUTFIELD)) {
				if (.getStackDepth() > 1) {
					OpcodeStack.Item item = .getStackItem(1);
					if (item.getRegisterNumber() == 0) {
						uValue = (Comparable<?>).getStackItem(0).getUserValue();
					}
				}
else if ( && (seen == GETFIELD)) {
				if (.getStackDepth() > 0) {
					OpcodeStack.Item item = .getStackItem(0);
					if (item.getRegisterNumber() == 0) {
						sawLoad = true;
					}
				}
else if (((seen > IFEQ) && (seen <= GOTO)) || (seen == IFNULL) || (seen == IFNONNULL)) {
else if (seen == CHECKCAST) {
				if (.getStackDepth() > 0) {
					OpcodeStack.Item itm = .getStackItem(0);
					uValue = (Comparable<?>)itm.getUserValue();
					if (uValue != null) {
						regOrField = uValue;
						sawAlias = true;
					}
				}
			}
catch (ClassNotFoundException cnfe) {
			.reportMissingClass(cnfe);
finally {
			TernaryPatcher.pre(seen);
			.sawOpcode(thisseen);
			TernaryPatcher.post(seen);
			if (sawAlias) {
				if (.getStackDepth() > 0) {
					OpcodeStack.Item itm = .getStackItem(0);
					itm.setUserValue(regOrField);
				}
else if (sawLoad) {
				if (.getStackDepth() > 0) {
					OpcodeStack.Item itm = .getStackItem(0);
					int reg = itm.getRegisterNumber();
					if (reg >= 0) {
						uValue = .get(Integer.valueOf(reg));
						itm.setUserValue(uValue);
else {
						XField xField = itm.getXField();
						if (xField != null) {
							uValue = .get(xField.getName());
							itm.setUserValue(uValue);
						}
					}
				}
			}
		}
	}

determines if the stack item refers to a collection that is stored in a local variable param item the stack item to check

Returns:
the register number of the local variable that this collection refers to, or -1
Throws:
ClassNotFoundException if the items class cannot be found
	private int isLocalCollection(OpcodeStack.Item itemthrows ClassNotFoundException {
		Comparable<?> aliasReg = (Comparable<?>)item.getUserValue();
		if (aliasReg instanceof Integer)
			return ((Integer)aliasReg).intValue();
		int reg = item.getRegisterNumber();
		if (reg < 0)
			return -1;
		JavaClass cls = item.getJavaClass();
		if ((cls != null) && cls.implementationOf())
			return reg;
		return -1;
	}

determines if the stack item refers to a collection that is stored in a field param item the stack item to check

Returns:
the field name of the collection, or null
Throws:
ClassNotFoundException if the items class cannot be found
	private String isFieldCollection(OpcodeStack.Item itemthrows ClassNotFoundException {
			Comparable<?> aliasReg = (Comparable<?>)item.getUserValue();
			if (aliasReg instanceof String)
				return (String)aliasReg;
			XField field = item.getXField();
			if (field == null)
				return null;
			JavaClass cls = item.getJavaClass();
			if ((cls != null) && cls.implementationOf())
				return field.getName();
			return null;
	}
	private void removeLoop(int pc) {
		while (it.hasNext()) {
			if (it.next().isInLoop(pc)) {
				it.remove();
			}
		}
	}
	static class LoopInfo
	{
		private final int start;
		private final int end;
		private int addPC;
		public LoopInfo(int loopStartint loopEnd)
		{
			 = loopStart;
			 = loopEnd;
			 = 0;
		}
		public boolean isInLoop(int pc)
		{
			return ((pc >= ) && (pc <= ));
		}
		public void foundAdd(int pc) {
			if ( == 0)
				 = pc;
			else
				 = -1;
		}
		public int getStartPC() {
			return ;
		}
		public int getEndPC() {
			return ;
		}
		public int getAddPC() {
			return ;
		}
	}
New to GrepCode? Check out our FAQ X