/*
 * Cobertura - http://cobertura.sourceforge.net/
 *
 * Copyright (C) 2011 Piotr Tabor
 *
 * Note: This file is dual licensed under the GPL and the Apache
 * Source License (so that it can be used from both the main
 * Cobertura classes and the ant tasks).
 *
 * Cobertura is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * Cobertura 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Cobertura; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

package net.sourceforge.cobertura.instrument;

import net.sourceforge.cobertura.util.RegexUtil;
import org.objectweb.asm.Label;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.tree.AbstractInsnNode;
import org.objectweb.asm.tree.InsnNode;
import org.objectweb.asm.tree.MethodInsnNode;
import org.objectweb.asm.tree.VarInsnNode;

import java.util.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Pattern;

Analyzes given method, assign unique event identifiers to every found interesting instruction and calls business method in the touchPointListener. 
Author:
ptab/**
 * Analyzes given method, assign unique event identifiers to every found
 * interesting instruction and calls business method in the {@link #touchPointListener}.
 *
 * @author ptab
 */
public class FindTouchPointsMethodAdapter
		extends
			ContextMethodAwareMethodAdapter {
	
Source of identifiers for events.

Remember to acquire identifiers using AtomicInteger.incrementAndGet() (not AtomicInteger.getAndIncrement()!!!)
/**
	 * Source of identifiers for events.
	 * <p/>
	 * <p>Remember to acquire identifiers using {@link AtomicInteger#incrementAndGet()} (not {@link AtomicInteger#getAndIncrement()}!!!)</p>
	 */
	private final AtomicInteger eventIdGenerator;

	
Backing listener that will be informed about all interesting events found
/**
	 * Backing listener that will be informed about all interesting events found
	 */
	private TouchPointListener touchPointListener;

	
Line number of current line.

It it NOT lineId
/**
	 * Line number of current line.
	 * <p/>
	 * <p>It it NOT lineId</pl>
	 */
	private int currentLine;

	
List of patterns to know that we don't want trace lines that are calls to some methods
/**
	 * List of patterns to know that we don't want trace lines that are calls to some methods
	 */
	private Collection ignoreRegexp;

	
See AbstractFindTouchPointsClassInstrumenter.duplicatedLinesMap /**
	 * See {@link AbstractFindTouchPointsClassInstrumenter#duplicatedLinesMap}
	 */
	private final Map<Integer, Map<Integer, Integer>> duplicatedLinesMap;

	
Map of (line number -> (lineId -> List of eventIds)).

For every line number, and for evere lineId in the line we store list of all generated events

When we will detect duplicated block of code in given line - instead of generating new eventIds we will
use the same events
/**
	 * Map of (line number -> (lineId -> List of eventIds)).
	 * <p/>
	 * <p>For every line number, and for evere lineId in the line we store list of all generated events</p>
	 * <p/>
	 * <p>When we will detect duplicated block of code in given line - instead of generating new eventIds we will
	 * use the same events</p>
	 */
	private final Map<Integer, Map<Integer, LinkedList<Integer>>> line2eventIds = new HashMap<Integer, Map<Integer, LinkedList<Integer>>>();

	
If we are currently processing a new (not duplicated line), it is a list (linked into line2eventIds) that we use to store newly generated identifiers into it, otherwise it is null. /**
	 * If we are currently processing a new (not duplicated line), it is a list (linked into {@link #line2eventIds}) that we use to store newly generated identifiers into it,
	 * otherwise it  is null.
	 */
	private LinkedList<Integer> saveEventIdList = null;

	
If we are currently processing a duplicated line, it is a list of identifiers that should be used for the line. After processing event, you should remove identifier from the begining of the list.
/**
	 * If we are currently processing a duplicated line, it is a list of identifiers that should be used for the line. After processing event, you should remove identifier from the begining of the list.
	 */
	private LinkedList<Integer> replyEventIdList = null;

	
State of last N instructions.
/**
	 * State of last N instructions.
	 */
	private final List<AbstractInsnNode> backlog;

	public FindTouchPointsMethodAdapter(HistoryMethodAdapter mv,
			String className, String methodName, String methodSignature,
			AtomicInteger eventIdGenerator,
			Map<Integer, Map<Integer, Integer>> duplicatedLinesMap,
			AtomicInteger lineIdGenerator) {
		this(mv, mv.backlog(), className, methodName, methodSignature,
				eventIdGenerator, duplicatedLinesMap, lineIdGenerator);
	}

	public FindTouchPointsMethodAdapter(MethodVisitor mv, String className,
			String methodName, String methodSignature,
			AtomicInteger eventIdGenerator,
			Map<Integer, Map<Integer, Integer>> duplicatedLinesMap,
			AtomicInteger lineIdGenerator) {
		this(mv, Collections.<AbstractInsnNode> emptyList(), className,
				methodName, methodSignature, eventIdGenerator,
				duplicatedLinesMap, lineIdGenerator);
	}

	protected FindTouchPointsMethodAdapter(MethodVisitor mv,
			List<AbstractInsnNode> backlog, String className,
			String methodName, String methodSignature,
			AtomicInteger eventIdGenerator,
			Map<Integer, Map<Integer, Integer>> duplicatedLinesMap,
			AtomicInteger lineIdGenerator) {
		super(mv, className, methodName, methodSignature, lineIdGenerator);
		this.backlog = backlog;
		this.eventIdGenerator = eventIdGenerator;
		this.duplicatedLinesMap = duplicatedLinesMap;
	}

	private int generateNewEventId() {
		return eventIdGenerator.incrementAndGet();
	}

	
Depending on situation if we are processing a new line or duplicated line,
generates a new identifier or reuses previously generated for the same event.
Returns:
/**
	 * Depending on situation if we are processing a new line or duplicated line,
	 * generates a new identifier or reuses previously generated for the same event.
	 *
	 * @return

	 */
	private int getEventId() {
		if (replyEventIdList != null && !replyEventIdList.isEmpty()) {
			//in case of a duplicated line
			return replyEventIdList.removeFirst();
		} else {
			// in case of a new line
			int eventId = generateNewEventId();
			if (saveEventIdList != null) {
				saveEventIdList.addLast(eventId);
			}
			return eventId;
		}
	}

	@Override
	public void visitCode() {
		super.visitCode();
		touchPointListener.afterMethodStart(mv);
	}

	
Processing information about new line.
 Upgrades replyEventIdList and saveEventIdList and calls TouchPointListener.afterLineNumber(int, Label, int, MethodVisitor, String, String) /**
	 * Processing information about new line.
	 * <p/>
	 * Upgrades {@link #replyEventIdList} and {@link #saveEventIdList} and calls {@link TouchPointListener#afterLineNumber(int, Label, int, MethodVisitor, String, String)}
	 */
	public void visitLineNumber(int line, Label label) {
		super.visitLineNumber(line, label);
		currentLine = line;

		if (!isDuplicatedLine(line, lastLineId)) {
			/*
			 * It is a new line (first time seen, so we will save all found
			 * events)
			 */
			replyEventIdList = null;
			saveEventIdList = new LinkedList<Integer>();
			Map<Integer, LinkedList<Integer>> eventsMap = line2eventIds
					.get(line);
			if (eventsMap == null) {
				eventsMap = new HashMap<Integer, LinkedList<Integer>>();
				line2eventIds.put(line, eventsMap);
			}
			eventsMap.put(lastLineId, saveEventIdList);
		} else {
			Integer orgin = getOriginForLine(line, lastLineId);
			Map<Integer, LinkedList<Integer>> m = line2eventIds
					.get(currentLine);
			LinkedList<Integer> eventIds = m.get(orgin);

			/* copy of  current list */
			replyEventIdList = new LinkedList<Integer>(eventIds);
			saveEventIdList = null;
		}

		touchPointListener.afterLineNumber(getEventId(), label, currentLine,
				mv, methodName, methodSignature);
	}

	
Checks if given line is a duplicate of previously processed line
Params:
line –   - line number
lineId – - line identifier
Returns:
true - if line is duplicate of previously processed lines/**
	 * Checks if given line is a duplicate of previously processed line
	 *
	 * @param line   - line number
	 * @param lineId - line identifier
	 *
	 * @return true - if line is duplicate of previously processed lines
	 */
	private boolean isDuplicatedLine(int line, Integer lineId) {
		return getOriginForLine(line, lineId) != null;
	}

	
Params:
line –   - line number
lineId – - line identifier
Returns:
lineId of the origin line (first processed line) that the given line is duplicate of.
        If the current line is not an duplicate of the previously processed line the method returns NULL./**
	 * @param line   - line number
	 * @param lineId - line identifier
	 *
	 * @return lineId of the origin line (first processed line) that the given line is duplicate of.
	 *         If the current line is not an duplicate of the previously processed line the method returns NULL.
	 */
	private Integer getOriginForLine(int line, Integer lineId) {
		Map<Integer, Integer> labelMap = duplicatedLinesMap.get(line);
		return labelMap != null ? labelMap.get(lineId) : null;
	}

	@Override
	public void visitLabel(Label label) {
		int eventId = getEventId();
		touchPointListener.beforeLabel(eventId, label, currentLine, mv);
		super.visitLabel(label);
		touchPointListener.afterLabel(eventId, label, currentLine, mv);
	}

	@Override
	public void visitJumpInsn(int opcode, Label label) {
		/* Ignore any jump instructions in the "class init" method.
		 When initializing static variables, the JVM first checks
		 that the variable is null before attempting to set it.
		 This check contains an IFNONNULL jump instruction which
		 would confuse people if it showed up in the reports.*/
		if ((opcode != Opcodes.GOTO) && (opcode != Opcodes.JSR)
				&& (currentLine != 0) && (!methodName.equals("<clinit>"))) {
			int eventId = getEventId();
			touchPointListener.beforeJump(eventId, label, currentLine, mv);
			super.visitJumpInsn(opcode, label);
			touchPointListener.afterJump(eventId, label, currentLine, mv);
		} else {
			super.visitJumpInsn(opcode, label);
		}
	}

	@Override
	public void visitMethodInsn(int opcode, String owner, String method,
			String descr) {
		super.visitMethodInsn(opcode, owner, method, descr);
		//We skip lines that contains call to methods that are specified inside ignoreRegexp
		if (RegexUtil.matches(ignoreRegexp, owner)) {
			touchPointListener.ignoreLine(getEventId(), currentLine);
		}
	}

	@Override
	public void visitLookupSwitchInsn(Label def, int[] values, Label[] labels) {
		touchPointListener.beforeSwitch(getEventId(), def, labels, currentLine,
				mv, tryToFindSignatureOfConditionEnum());
		super.visitLookupSwitchInsn(def, values, labels);
	}

	@Override
	public void visitTableSwitchInsn(int min, int max, Label def, Label[] labels) {
		touchPointListener.beforeSwitch(getEventId(), def, labels, currentLine,
				mv, tryToFindSignatureOfConditionEnum());
		super.visitTableSwitchInsn(min, max, def, labels);
	}

	enum Abc {
		A, B
	}

	;

	
We try to detect such a last 2 instructions and extract the enum signature.
/**
	 * We try to detect such a last 2 instructions and extract the enum signature.
	 */
	private String tryToFindSignatureOfConditionEnum() {
		//		mv.visitMethodInsn(INVOKESTATIC, "net/sourceforge/cobertura/instrument/FindTouchPointsMethodAdapter", "$SWITCH_TABLE$net$sourceforge$cobertura$instrument$FindTouchPointsMethodAdapter$Abc", "()[I");
		//		mv.visitVarInsn(ALOAD, 1);
		//		mv.visitMethodInsn(INVOKEVIRTUAL, "net/sourceforge/cobertura/instrument/FindTouchPointsMethodAdapter$Abc", "ordinal", "()I");
		//		mv.visitInsn(IALOAD);

		if (backlog == null || backlog.size() < 4)
			return null;
		int last = backlog.size() - 1;
		if ((backlog.get(last) instanceof InsnNode)
				&& (backlog.get(last - 1) instanceof MethodInsnNode)
				&& (backlog.get(last - 2) instanceof VarInsnNode)) {
			VarInsnNode i2 = (VarInsnNode) backlog.get(last - 2);
			MethodInsnNode i3 = (MethodInsnNode) backlog.get(last - 1);
			InsnNode i4 = (InsnNode) backlog.get(last);
			if ((i2.getOpcode() == Opcodes.ALOAD)
					&& (i3.getOpcode() == Opcodes.INVOKEVIRTUAL && i3.name
							.equals("ordinal"))
					&& (i4.getOpcode() == Opcodes.IALOAD)) {
				return i3.owner;
			}
		}
		return null;
	}

	// ===========  Getters and setters =====================

	
Gets backing listener that will be informed about all interesting events found
/**
	 * Gets backing listener that will be informed about all interesting events found
	 */
	public TouchPointListener getTouchPointListener() {
		return touchPointListener;
	}

	
Niestety terminalnie.
Sets backing listener that will be informed about all interesting events found
/**
	 * Niestety terminalnie.
	 * Sets backing listener that will be informed about all interesting events found
	 */
	public void setTouchPointListener(TouchPointListener touchPointListener) {
		this.touchPointListener = touchPointListener;
	}

	
Returns:
list of patterns to know that we don't want trace lines that are calls to some methods/**
	 * @return list of patterns to know that we don't want trace lines that are calls to some methods
	 */
	public Collection<Pattern> getIgnoreRegexp() {
		return ignoreRegexp;
	}

	
sets list of patterns to know that we don't want trace lines that are calls to some methods
/**
	 * sets list of patterns to know that we don't want trace lines that are calls to some methods
	 */
	public void setIgnoreRegexp(Collection<Pattern> ignoreRegexp) {
		this.ignoreRegexp = ignoreRegexp;
	}

}