/* ###
 * 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 java.util.ArrayList;
import java.util.List;

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

/**
 * This class represents various flavors of Method List 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 AbstractMethodListMsType extends AbstractMsType {

	protected List<AbstractMethodRecordMs> methodRecords = new ArrayList<>();

	/**
	 * 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 AbstractMethodListMsType(AbstractPdb pdb, PdbByteReader reader) throws PdbException {
		super(pdb, reader);
		while (reader.hasMore()) {
			AbstractMethodRecordMs record = parseOneRecord(pdb, reader);
			methodRecords.add(record);
		}
	}

	/**
	 * Returns the size of the list of methods.
	 * @return Size of the methods.
	 */
	public int getListSize() {
		return methodRecords.size();
	}

	/**
	 * Return list of {@link AbstractMethodRecordMs}
	 * @return list of method records.
	 */
	public List<AbstractMethodRecordMs> getList() {
		return methodRecords;
	}

	@Override
	public void emit(StringBuilder builder, Bind bind) {
		// Making this up; no API for output.
		DelimiterState ds = new DelimiterState("", ",");
		builder.append("{");
		for (AbstractMethodRecordMs record : methodRecords) {
			builder.append(ds.out(true, record.toString()));
		}
		builder.append("}");
	}

	/**
	 * Method to parse one record.
	 * @param pdbIn {@link AbstractPdb} to which this type belongs.
	 * @param reader {@link PdbByteReader} from which this type is deserialized.
	 * @return {@link AbstractMethodRecordMs} record parsed.
	 * @throws PdbException Upon not enough data left to parse.
	 */
	protected abstract AbstractMethodRecordMs parseOneRecord(AbstractPdb pdbIn,
			PdbByteReader reader) throws PdbException;

}
