/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ghidra.app.util.bin.format.pdb2.pdbreader.type;

import ghidra.app.util.bin.format.pdb2.pdbreader.*;

/**
 * This class represents various flavors of Virtual Function Table Pointer With Offset type.
 * <P>
 * Note: we do not necessarily understand each of these data type classes.  Refer to the
 *  base class for more information.
 */
public abstract class AbstractVirtualFunctionTablePointerWithOffsetMsType
		extends AbstractVirtualFunctionTablePointerMsType {

	protected int offset;

	/**
	 * Constructor for this type.
	 * @param pdb {@link AbstractPdb} to which this type belongs.
	 * @param reader {@link PdbByteReader} from which this type is deserialized.
	 * @param recordNumberSize size of record number to parse.
	 * @param skipPaddingSize number of bytes of padding to skip at specific padding spot.
	 * @throws PdbException Upon not enough data left to parse.
	 */
	public AbstractVirtualFunctionTablePointerWithOffsetMsType(AbstractPdb pdb,
			PdbByteReader reader, int recordNumberSize, int skipPaddingSize) throws PdbException {
		super(pdb, reader);
		reader.parseBytes(skipPaddingSize); // padding
		pointerTypeRecordNumber =
			RecordNumber.parse(pdb, reader, RecordCategory.TYPE, recordNumberSize);
		offset = reader.parseInt();
	}

	/**
	 * Returns the record number of the pointer type.
	 * @return the record number of the pointer type.
	 */
	@Override
	public RecordNumber getPointerTypeRecordNumber() {
		return pointerTypeRecordNumber;
	}

	/**
	 * Returns the pointer offset.
	 * @return the offset.
	 */
	@Override
	public int getOffset() {
		return offset;
	}

	@Override
	public void emit(StringBuilder builder, Bind bind) {
		builder.append("VFTablePtr<off=");
		builder.append(offset);
		builder.append(">: ");
		builder.append(pdb.getTypeRecord(pointerTypeRecordNumber));
	}

}
