001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.commons.compress.harmony.unpack200.bytecode.forms;
020
021import org.apache.commons.compress.harmony.pack200.Pack200Exception;
022import org.apache.commons.compress.harmony.unpack200.SegmentConstantPool;
023import org.apache.commons.compress.harmony.unpack200.bytecode.ByteCode;
024import org.apache.commons.compress.harmony.unpack200.bytecode.ClassFileEntry;
025import org.apache.commons.compress.harmony.unpack200.bytecode.OperandManager;
026
027/**
028 * Abstract superclass of all classes that have class-specific references to constant pool information. These classes have a context (a string representing a
029 * pack200 class) i.e., they send getClassSpecificPoolEntry instead of getConstantPoolEntry.
030 */
031public abstract class ClassSpecificReferenceForm extends ReferenceForm {
032
033    /**
034     * Constructs a new instance with the specified opcode, name, operandType and rewrite.
035     *
036     * @param opcode  index corresponding to the opcode's value.
037     * @param name    String printable name of the opcode.
038     * @param rewrite Operand positions (which will later be rewritten in ByteCodes) are indicated by -1.
039     */
040    public ClassSpecificReferenceForm(final int opcode, final String name, final int[] rewrite) {
041        super(opcode, name, rewrite);
042    }
043
044    protected abstract String context(OperandManager operandManager);
045
046    @Override
047    protected abstract int getOffset(OperandManager operandManager);
048
049    @Override
050    protected abstract int getPoolID();
051
052    @Override
053    protected void setNestedEntries(final ByteCode byteCode, final OperandManager operandManager, final int offset) throws Pack200Exception {
054        final SegmentConstantPool globalPool = operandManager.globalConstantPool();
055        final ClassFileEntry[] nested = { globalPool.getClassSpecificPoolEntry(getPoolID(), offset, context(operandManager)) };
056        byteCode.setNested(nested);
057        byteCode.setNestedPositions(new int[][] { { 0, 2 } });
058    }
059
060}