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

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

//++
// File:		MICmdCmdVar.h
//
// Overview:	CMICmdCmdVarCreate				interface.
//				CMICmdCmdVarUpdate				interface.
//				CMICmdCmdVarDelete				interface.
//				CMICmdCmdVarAssign				interface.
//				CMICmdCmdVarSetFormat			interface.
//				CMICmdCmdVarListChildren		interface.
//				CMICmdCmdVarEvaluateExpression	interface.
//				CMICmdCmdVarInfoPathExpression	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

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

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

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

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

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

// Attribute:
private:
	CMIUtilString		m_strVarName;
	MIuint				m_nChildren;
	MIuint				m_nMore;
	MIuint64			m_nThreadId;
	CMIUtilString		m_strType;
	bool				m_bValid;						// True = Variable is valid, false = not valid		
	CMIUtilString		m_strExpression;
	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
	const CMIUtilString	m_constStrArgName;
	const CMIUtilString	m_constStrArgFrameAddr;
	const CMIUtilString	m_constStrArgExpression;	
};

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

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

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

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

// Attribute:
private:
	CMIUtilString		m_strValueName;
	const CMIUtilString	m_constStrArgPrintValues;	// Not handled by *this command
	const CMIUtilString	m_constStrArgName;
};

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

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

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

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

// Attribute:
private:
	const CMIUtilString	m_constStrArgName;
};

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

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

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

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

// Attributes:
private:
	bool				m_bOk;						// True = success, false = failure
	CMIUtilString		m_varObjName;
	const CMIUtilString	m_constStrArgName;
	const CMIUtilString	m_constStrArgExpression;	
};

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

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

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

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

// Attributes:
private:
	CMIUtilString		m_varObjName;
	const CMIUtilString	m_constStrArgName;
	const CMIUtilString	m_constStrArgFormatSpec;	
};

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

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

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

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

// Typedefs:
private:
	typedef std::vector< CMICmnMIValueResult >	VecMIValueResult_t;

// Attributes:
private:
	bool				m_bValueValid;				// True = yes SBValue object is valid, false = not valid
	VecMIValueResult_t	m_vecMiValueResult;
	MIuint				m_nChildren;
	const CMIUtilString	m_constStrArgPrintValues;	// Not handled by *this command
	const CMIUtilString	m_constStrArgName;
};

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

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

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

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

// Attributes:
private:
	bool				m_bValueValid;				// True = yes SBValue object is valid, false = not valid
	CMIUtilString		m_varObjName;
	const CMIUtilString	m_constStrArgFormatSpec;	// Not handled by *this command
	const CMIUtilString	m_constStrArgName;
};

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

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

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

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

// Attributes:
private:
	bool				m_bValueValid;			// True = yes SBValue object is valid, false = not valid
	CMIUtilString		m_strPathExpression;
	const CMIUtilString	m_constStrArgName;
};