llvm-project/lldb/tools/lldb-mi/MICmnMIResultRecord.cpp

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

//++
// File:		MICmnMIResultRecord.h
//
// Overview:	CMICmnMIResultRecord implementation.
//
// Environment:	Compilers:	Visual C++ 12.
//							gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1
//				Libraries:	See MIReadmetxt. 
//
// Copyright:	None.
//--

// In-house headers:
#include "MICmnMIResultRecord.h"
#include "MICmnResources.h"

// Instantiations:
CMICmnMIResultRecord::MapResultClassToResultClassText_t ms_MapResultClassToResultClassText = 
{
	{ CMICmnMIResultRecord::eResultClass_Done, "done" },
	{ CMICmnMIResultRecord::eResultClass_Running, "running" },
	{ CMICmnMIResultRecord::eResultClass_Connected, "connected" },
	{ CMICmnMIResultRecord::eResultClass_Error, "error" },
	{ CMICmnMIResultRecord::eResultClass_Exit, "exit" }
};
const CMIUtilString CMICmnMIResultRecord::ms_constStrResultRecordHat( "^");

//++ ------------------------------------------------------------------------------------
// Details:	CMICmnMIResultRecord constructor.
// Type:	Method.
// Args:	None.
// Return:	None.
// Throws:	None.
//--
CMICmnMIResultRecord::CMICmnMIResultRecord( void )
:	m_strResultRecord( MIRSRC( IDS_WORD_INVALIDBRKTS ) )
{
}

//++ ------------------------------------------------------------------------------------
// Details:	CMICmnMIResultRecord constructor.
// Type:	Method.
// Args:	vToken	- (R) The command's number.
//			veType	- (R) A MI result class enumeration.
// Return:	None.
// Throws:	None.
//--
CMICmnMIResultRecord::CMICmnMIResultRecord( const MIuint vToken, const ResultClass_e veType )
:	m_nResultRecordToken( vToken )
,	m_eResultRecordResultClass( veType )
,	m_strResultRecord( MIRSRC( IDS_WORD_INVALIDBRKTS ) )
{
	BuildResultRecord();
}

//++ ------------------------------------------------------------------------------------
// Details:	CMICmnMIResultRecord constructor.
// Type:	Method.
// Args:	vToken		- (R) The command's number.
//			veType		- (R) A MI result class enumeration.
//			vMIResult	- (R) A MI result object.
// Return:	None.
// Throws:	None.
//--
CMICmnMIResultRecord::CMICmnMIResultRecord( const MIuint vToken, const ResultClass_e veType, const CMICmnMIValueResult & vValue )
:	m_nResultRecordToken( vToken )
,	m_eResultRecordResultClass( veType )
,	m_strResultRecord( MIRSRC( IDS_WORD_INVALIDBRKTS ) )
,	m_partResult( vValue )	
{
	BuildResultRecord();
	Add( m_partResult );
}

//++ ------------------------------------------------------------------------------------
// Details:	CMICmnMIResultRecord destructor.
// Type:	Overrideable.
// Args:	None.
// Return:	None.
// Throws:	None.
//--
CMICmnMIResultRecord::~CMICmnMIResultRecord( void )
{
}

//++ ------------------------------------------------------------------------------------
// Details:	Return the MI result record as a string. The string is a direct result of
//			work done on *this result record so if not enough data is added then it is
//			possible to return a malformed result record. If nothing has been set or 
//			added to *this MI result record object then text "<Invalid>" will be returned.
// Type:	Method.
// Args:	None.
// Return:	CMIUtilString &	- MI output text.
// Throws:	None.
//--
const CMIUtilString & CMICmnMIResultRecord::GetString( void ) const
{
	return m_strResultRecord;
}
	
//++ ------------------------------------------------------------------------------------
// Details:	Build the result record's mandatory data part. The part up to the first
//			(additional) result i.e. result-record ==>  [ token ] "^" result-class.
// Type:	Method.
// Args:	None.
// Return:	MIstatus::success - Functional succeeded.
//			MIstatus::failure - Functional failed.
// Throws:	None.
//--
bool CMICmnMIResultRecord::BuildResultRecord( void )
{
	const char * pFormat = "%d%s%s";
	const CMIUtilString & rStrResultRecord( ms_MapResultClassToResultClassText[ m_eResultRecordResultClass ] );
	m_strResultRecord = CMIUtilString::Format( pFormat, m_nResultRecordToken, ms_constStrResultRecordHat.c_str(), rStrResultRecord.c_str() );

	return MIstatus::success;
}

//++ ------------------------------------------------------------------------------------
// Details:	Add to *this result record additional information.
// Type:	Method.
// Args:	vMIValue	- (R) A MI value derived object.
// Return:	MIstatus::success - Functional succeeded.
//			MIstatus::failure - Functional failed.
// Throws:	None.
//--
bool CMICmnMIResultRecord::Add( const CMICmnMIValue & vMIValue )
{
	m_strResultRecord += ",";
	m_strResultRecord += vMIValue.GetString();	

	return MIstatus::success;
}

// Example usage:
// Forms: 5^done,stack-args=[frame={level="0",args=[{name="argc",value="1"},{name="argv",value="
//	#include "MICmnMIResultRecord.h"
//	#include "MICmnMIValueList.h"
//	#include "MICmnMIValueConst.h"
//	#include "MICmnMIValueResult.h"
//	#include "MICmnMIValueTuple.h"
	//CMICmnMIValueResult miValueResult1( "name", CMICmnMIValueConst( "argc") );
	//CMICmnMIValueResult miValueResult2( "value", CMICmnMIValueConst( "1") );
	//CMICmnMIValueTuple miValueTuple1( miValueResult1 );
	//miValueTuple1.Add( miValueResult2 );
	//CMICmnMIValueList miValueList1( miValueTuple1 );
	//miValueList1.Add( miValueTuple1 );
	//CMICmnMIValueResult miValueResult3( "args", miValueList1 );
	//CMICmnMIValueResult miValueResult4( "level", CMICmnMIValueConst( "0" ) );
	//CMICmnMIValueTuple miValueTuple2( miValueResult4 );
	//miValueTuple2.Add( miValueResult3 );
	//CMICmnMIValueResult miValueResult5( "frame", miValueTuple2 );
	//CMICmnMIValueList miValueList2( miValueResult5 );
	//CMICmnMIValueResult miValueResult6( "stack-args", miValueList2 );
	//CMICmnMIResultRecord miResultRecord( 5, CMICmnMIResultRecord::eResultClass_Done, miValueResult6 );
	//CMIUtilString str( miResultRecord.GetString() );