llvm-project/lldb/tools/lldb-mi/MICmdCmdExec.h

//===-- MICmdCmdExec.h ------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

//++
// File:		MICmdCmdExec.h
//
// Overview:	CMICmdCmdExecRun				interface.
//				CMICmdCmdExecContinue			interface.
//				CMICmdCmdExecNext				interface. 
//				CMICmdCmdExecStep				interface.
//				CMICmdCmdExecNextInstruction	interface.
//				CMICmdCmdExecStepInstruction	interface.
//				CMICmdCmdExecFinish				interface.
//
//				To implement new MI commands derive a new command class from the command base 
//				class. To enable the new command for interpretation add the new command class
//				to the command factory. The files of relevance are:
//					MICmdCommands.cpp
//					MICmdBase.h / .cpp
//					MICmdCmd.h / .cpp
//				For an introduction to adding a new command see CMICmdCmdSupportInfoMiCmdQuery
//				command class as an example.
//
// Environment:	Compilers:	Visual C++ 12.
//							gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1
//				Libraries:	See MIReadmetxt. 
//
// Copyright:	None.
//--

#pragma once

// Third party headers:
#include <lldb/API/SBCommandReturnObject.h>

// In-house headers:
#include "MICmdBase.h"

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-run".
// Gotchas:	None.
// Authors:	Illya Rudkin 07/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecRun : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecRun( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecRun( void );
};

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-continue".
// Gotchas:	None.
// Authors:	Illya Rudkin 07/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecContinue : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecContinue( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecContinue( void );

// Attributes:
private:
	lldb::SBCommandReturnObject m_lldbResult;
};

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-next".
// Gotchas:	None.
// Authors:	Illya Rudkin 25/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecNext : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecNext( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );
	virtual bool	ParseArgs( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecNext( void );

// Attributes:
private:
	lldb::SBCommandReturnObject m_lldbResult;
	const CMIUtilString			m_constStrArgThread;	// Not specified in MI spec but Eclipse gives this option
	const CMIUtilString			m_constStrArgNumber;	// Not specified in MI spec but Eclipse gives this option
};

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-step".
// Gotchas:	None.
// Authors:	Illya Rudkin 25/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecStep : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecStep( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );
	virtual bool	ParseArgs( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecStep( void );

// Attributes:
private:
	lldb::SBCommandReturnObject m_lldbResult;
	const CMIUtilString			m_constStrArgThread;	// Not specified in MI spec but Eclipse gives this option
	const CMIUtilString			m_constStrArgNumber;	// Not specified in MI spec but Eclipse gives this option
};

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-next-instruction".
// Gotchas:	None.
// Authors:	Illya Rudkin 25/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecNextInstruction : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecNextInstruction( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );
	virtual bool	ParseArgs( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecNextInstruction( void );

// Attributes:
private:
	lldb::SBCommandReturnObject m_lldbResult;
	const CMIUtilString			m_constStrArgThread;	// Not specified in MI spec but Eclipse gives this option
};

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-step-instruction".
// Gotchas:	None.
// Authors:	Illya Rudkin 25/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecStepInstruction : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecStepInstruction( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );
	virtual bool	ParseArgs( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecStepInstruction( void );

// Attributes:
private:
	lldb::SBCommandReturnObject m_lldbResult;
	const CMIUtilString			m_constStrArgThread;	// Not specified in MI spec but Eclipse gives this option
};

//++ ============================================================================
// Details:	MI command class. MI commands derived from the command base class.
//			*this class implements MI command "exec-finish".
// Gotchas:	None.
// Authors:	Illya Rudkin 25/03/2014.
// Changes:	None.
//--
class CMICmdCmdExecFinish : public CMICmdBase
{
// Statics:
public:
	// Required by the CMICmdFactory when registering *this commmand
	static CMICmdBase *	CreateSelf( void );

// Methods:
public:
	/* ctor */	CMICmdCmdExecFinish( void );

// Overridden:
public:
	// From CMICmdInvoker::ICmd
	virtual bool	Execute( void );
	virtual bool	Acknowledge( void );
	virtual bool	ParseArgs( void );

// Overridden:
public:
	// From CMICmnBase
	/* dtor */ virtual ~CMICmdCmdExecFinish( void );

// Attributes:
private:
	lldb::SBCommandReturnObject m_lldbResult;
	const CMIUtilString			m_constStrArgThread;	// Not specified in MI spec but Eclipse gives this option
	const CMIUtilString			m_constStrArgFrame;		// Not specified in MI spec but Eclipse gives this option
};