001: /*
002: * @(#)CallPairMeasure.java
003: *
004: * Copyright (C) 2003 Matt Albrecht
005: * groboclown@users.sourceforge.net
006: * http://groboutils.sourceforge.net
007: *
008: * Permission is hereby granted, free of charge, to any person obtaining a
009: * copy of this software and associated documentation files (the "Software"),
010: * to deal in the Software without restriction, including without limitation
011: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
012: * and/or sell copies of the Software, and to permit persons to whom the
013: * Software is furnished to do so, subject to the following conditions:
014: *
015: * The above copyright notice and this permission notice shall be included in
016: * all copies or substantial portions of the Software.
017: *
018: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
019: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
020: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
021: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
022: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
023: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
024: * DEALINGS IN THE SOFTWARE.
025: */
026:
027: package net.sourceforge.groboutils.codecoverage.v2.module;
028:
029: import net.sourceforge.groboutils.codecoverage.v2.IAnalysisMetaData;
030: import net.sourceforge.groboutils.codecoverage.v2.IAnalysisModule;
031: import net.sourceforge.groboutils.codecoverage.v2.IMethodCode;
032:
033: import org.apache.bcel.generic.Instruction;
034: import org.apache.bcel.generic.InstructionHandle;
035: import org.apache.bcel.generic.InvokeInstruction;
036:
037: /**
038: * Processes methods for call pair coverage analysis, where each function
039: * call instruction are marked.
040: * Currently, this does not support localization.
041: * <P>
042: * This is more accurately called "Object Code Branch Coverage", since
043: * true branch coverage requires the originating source code to correctly
044: * discover the branches.
045: * <P>
046: * This measure can be superior to line coverage due to the Java construct
047: * of the <tt>?:</tt> operation. This hides a branch inside a single
048: * statement. Also, some developers may put an <tt>if</tt> statement and
049: * its one-line branch all on the same line, which will hide the branch
050: * that was took.
051: *
052: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
053: * @version $Date: 2004/04/15 05:48:26 $
054: * @since February 17, 2003
055: * @see IAnalysisMetaData
056: */
057: public class CallPairMeasure implements IAnalysisModule {
058: /**
059: * Returns the human-readable name of the measure.
060: */
061: public String getMeasureName() {
062: return "Call Pair";
063: }
064:
065: /**
066: * Returns the unit name for this particular coverage measure.
067: */
068: public String getMeasureUnit() {
069: return "call";
070: }
071:
072: /**
073: * Returns the text format used in meta-data formatted text. This should
074: * be the mime encoding type, such as "text/plain" or "text/html".
075: */
076: public String getMimeEncoding() {
077: return "text/plain";
078: }
079:
080: /**
081: * Perform the analysis on the method.
082: */
083: public void analyze(IMethodCode method) {
084: BytecodeLineUtil blu = new BytecodeLineUtil(method);
085: InstructionHandle handles[] = blu.getHandles();
086:
087: // find the positions of the instructions in the bytecode
088: for (int i = 0; i < handles.length; ++i) {
089: InstructionHandle h = handles[i];
090: Instruction instr = h.getInstruction();
091: if (instr instanceof InvokeInstruction) {
092: // need to mark the target(s) and the next instruction, as it
093: // will be the "else" or "default" instruction.
094: int lineNo = blu.getLineNumber(h);
095: method.markInstruction(i, createMetaData(i, lineNo));
096: }
097: }
098: }
099:
100: private IAnalysisMetaData createMetaData(int bytecodePos, int lineNo) {
101: return new DefaultAnalysisMetaData("Invoke for line " + lineNo,
102: "Didn't cover invocation for line " + lineNo, (byte) 0);
103: }
104: }
|