/* ###
 * 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.som;

import java.io.IOException;

import ghidra.app.util.bin.BinaryReader;
import ghidra.app.util.bin.StructConverter;
import ghidra.program.model.data.DataType;
import ghidra.util.exception.DuplicateNameException;

/**
 * Abstract parent class for SOM auxiliary headers
 */
public abstract class SomAuxHeader implements StructConverter {

	protected SomAuxId auxId;

	/**
	 * Creates a new {@link SomAuxHeader}
	 * 
	 * @param reader A {@link BinaryReader} positioned at the start of the auxiliary header
	 * @throws IOException if there was an IO-related error
	 */
	public SomAuxHeader(BinaryReader reader) throws IOException {
		auxId = new SomAuxId(reader);
	}

	/**
	 * {@return this {@link SomAuxHeader}'s {@link SomAuxId aux ID}}
	 */
	public SomAuxId getAuxId() {
		return auxId;
	}

	/**
	 * {@return the length in bytes of this {@link SomAuxHeader auxiliary header} (including the
	 * size of the aux id)}
	 */
	public long getLength() {
		return auxId.getLength() + SomAuxId.SIZE;
	}

	@Override
	public abstract DataType toDataType() throws DuplicateNameException, IOException;
}
