001/***
002 * ASM: a very small and fast Java bytecode manipulation framework
003 * Copyright (c) 2000-2011 INRIA, France Telecom
004 * All rights reserved.
005 *
006 * Redistribution and use in source and binary forms, with or without
007 * modification, are permitted provided that the following conditions
008 * are met:
009 * 1. Redistributions of source code must retain the above copyright
010 *    notice, this list of conditions and the following disclaimer.
011 * 2. Redistributions in binary form must reproduce the above copyright
012 *    notice, this list of conditions and the following disclaimer in the
013 *    documentation and/or other materials provided with the distribution.
014 * 3. Neither the name of the copyright holders nor the names of its
015 *    contributors may be used to endorse or promote products derived from
016 *    this software without specific prior written permission.
017 *
018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
021 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
022 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
024 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
025 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
026 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
027 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
028 * THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package io.ebean.enhance.asm.tree;
031
032import io.ebean.enhance.asm.MethodVisitor;
033
034import java.util.Map;
035
036/**
037 * A node that represents a local variable instruction. A local variable
038 * instruction is an instruction that loads or stores the value of a local
039 * variable.
040 * 
041 * @author Eric Bruneton
042 */
043public class VarInsnNode extends AbstractInsnNode {
044
045    /**
046     * The operand of this instruction. This operand is the index of a local
047     * variable.
048     */
049    public int var;
050
051    /**
052     * Constructs a new {@link VarInsnNode}.
053     * 
054     * @param opcode
055     *            the opcode of the local variable instruction to be
056     *            constructed. This opcode must be ILOAD, LLOAD, FLOAD, DLOAD,
057     *            ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.
058     * @param var
059     *            the operand of the instruction to be constructed. This operand
060     *            is the index of a local variable.
061     */
062    public VarInsnNode(final int opcode, final int var) {
063        super(opcode);
064        this.var = var;
065    }
066
067    /**
068     * Sets the opcode of this instruction.
069     * 
070     * @param opcode
071     *            the new instruction opcode. This opcode must be ILOAD, LLOAD,
072     *            FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or
073     *            RET.
074     */
075    public void setOpcode(final int opcode) {
076        this.opcode = opcode;
077    }
078
079    @Override
080    public int getType() {
081        return VAR_INSN;
082    }
083
084    @Override
085    public void accept(final MethodVisitor mv) {
086        mv.visitVarInsn(opcode, var);
087        acceptAnnotations(mv);
088    }
089
090    @Override
091    public AbstractInsnNode clone(final Map<LabelNode, LabelNode> labels) {
092        return new VarInsnNode(opcode, var).cloneAnnotations(this);
093    }
094}