/* ###
 * 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 agent.gdb.manager.evt;

import agent.gdb.manager.impl.GdbStackFrameImpl;
import agent.gdb.manager.impl.GdbThreadImpl;
import agent.gdb.manager.parsing.GdbMiParser.GdbMiFieldList;
import agent.gdb.manager.parsing.GdbParsingUtils.GdbParseError;

/**
 * The event corresponding with "{@code =thread-selected}"
 */
public class GdbThreadSelectedEvent extends AbstractGdbEventWithFields {
	private final int tid;

	/**
	 * Construct a new event by parsing the tail for information
	 * 
	 * <p>
	 * The selected thread ID must be specified by GDB.
	 * 
	 * @param tail the text following the event type in the GDB/MI event record
	 * @throws GdbParseError if the tail cannot be parsed
	 */
	public GdbThreadSelectedEvent(CharSequence tail) throws GdbParseError {
		super(tail);
		this.tid = Integer.parseInt(getInfo().getString("id"));
	}

	/**
	 * Get the selected thread ID
	 * 
	 * @return the thread ID
	 */
	public int getThreadId() {
		return tid;
	}

	/**
	 * Get the selected frame, if applicable
	 * 
	 * @param thread the selected thread
	 * @return the frame
	 */
	public GdbStackFrameImpl getFrame(GdbThreadImpl thread) {
		GdbMiFieldList fields = getInfo().getFieldList("frame");
		return fields == null ? null : GdbStackFrameImpl.fromFieldList(thread, fields);
	}
}
