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

import java.io.Closeable;
import java.io.IOException;

import ghidra.app.util.importer.MessageLog;
import ghidra.program.model.listing.Program;
import ghidra.util.exception.CancelledException;
import ghidra.util.task.TaskMonitor;

public abstract class AbstractObjcTypeMetadata implements Closeable {

	protected Program program;
	protected TaskMonitor monitor;
	protected MessageLog log;
	protected ObjcState state;

	/**
	 * Creates a new {@link AbstractObjcTypeMetadata}
	 * 
	 * @param state The {@link ObjcState state}
	 * @param program The {@link Program}
	 * @param monitor A cancellable task monitor
	 * @param log The log
	 * @throws IOException if there was an IO-related error
	 * @throws CancelledException if the user cancelled the operation
	 */
	public AbstractObjcTypeMetadata(ObjcState state, Program program, TaskMonitor monitor,
			MessageLog log) throws IOException, CancelledException {
		this.state = state;
		this.program = program;
		this.monitor = monitor;
		this.log = log;
	}

	/**
	 * Applies the type metadata to the program
	 */
	public abstract void applyTo();

	/**
	 * Convenience method to perform logging
	 * 
	 * @param message The message to log
	 */
	public void log(String message) {
		log.appendMsg(getClass().getSimpleName(), message);
	}

	/**
	 * Convenience method to perform logging (with exception)
	 * 
	 * @param message The message to log
	 * @param e The exception to log
	 */
	public void log(String message, Exception e) {
		log.appendMsg(getClass().getSimpleName(), message + ": " + e.getMessage());
	}

	@Override
	public void close() {
		state.close();
	}
}
