/* ###
 * 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 the <B>MsType</B> flavor of Method Records.
 * <P>
 * Note: we do not necessarily understand each of these data type classes.  Refer to the
 *  base class for more information.
 */
public class MethodRecordMs extends AbstractMethodRecordMs {

	/**
	 * Constructor for this type.
	 * @param pdb {@link AbstractPdb} to which this type belongs.
	 * @param reader {@link PdbByteReader} from which this type is deserialized.
	 * @throws PdbException Upon not enough data left to parse.
	 */
	public MethodRecordMs(AbstractPdb pdb, PdbByteReader reader) throws PdbException {
		super(pdb, reader);
		attributes = new ClassFieldMsAttributes(reader);
		reader.parseBytes(2); // structure padding
		procedureRecordNumber = RecordNumber.parse(pdb, reader, RecordCategory.TYPE, 32);
		// API says optional offset "if intro virtual" but we have seen it for 6=<intro.pure>, so
		//  it could be that we need to also include 2=virtual here; i.e., each 2, 4, and 6
		//  (virtual, <intro>, and <intro,pure>) could have this optional field.
		if (attributes.getProperty() == ClassFieldMsAttributes.Property.INTRO ||
			attributes.getProperty() == ClassFieldMsAttributes.Property.INTRO_PURE) {
			optionalOffset = reader.parseUnsignedIntVal();
		}
		else {
			optionalOffset = -1;
		}
	}

}
