edu.berkeley.cs.jqf.instrument.tracing.events.BranchEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jqf-instrument Show documentation

JQF: Feedback-directed Quickcheck for Java - Instrumentation and event generation module

There is a newer version: 2.0

/*
 * Copyright (c) 2017-2018 The Regents of the University of California
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package edu.berkeley.cs.jqf.instrument.tracing.events;

import janala.logger.inst.MemberRef;

/**
 * @author Rohan Padhye
 */
public class BranchEvent extends TraceEvent {
    /**
     * The branch arm that is taken.
     *
     * For simple conditional branches, 0 is the
     * false branch and 1 is the true branch. For
     * switch-cases, the arm is the index of the case
     * statement (default arm = -1)
     */
    protected final int arm;

    public BranchEvent(int iid, MemberRef containingMethod, int lineNumber, int arm) {
        super(iid, containingMethod, lineNumber);
        this.arm = arm;
    }

    public int getArm() {
        return arm;
    }

    @Override
    public String toString() {
        return String.format("BRANCH(%d,%d,%d)", iid, arm, lineNumber);
    }

    @Override
    public void applyVisitor(TraceEventVisitor v) {
        v.visitBranchEvent(this);
    }
}