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

//++
// File:		MICmnMIValueTuple.h
//
// Overview:	CMICmnMIValueTuple interface.
//
// 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 "MICmnMIValue.h"
#include "MICmnMIValueResult.h"
#include "MICmnMIValueConst.h"

//++ ============================================================================
// Details:	MI common code MI Result class. Part of the CMICmnMIValueTupleRecord
//			set of objects.
//			The syntax is as follows:
//			result-record ==>  [ token ] "^" result-class ( "," result )* nl 
//			token = any sequence of digits
//			* = 0 to many
//			nl = CR | CR_LF
//			result-class ==> "done" | "running" | "connected" | "error" | "exit" 
//			result ==> variable "=" value
//			value ==> const | tuple | list  
//			const ==> c-string (7 bit iso c string content)
//			tuple ==>  "{}" | "{" result ( "," result )* "}"  
//			list ==>  "[]" | "[" value ( "," value )* "]" | "[" result ( "," result )* "]"  
//			More information see: 
//			http://ftp.gnu.org/old-gnu/Manuals/gdb-5.1.1/html_chapter/gdb_22.html
// Gotchas:	None.
// Authors:	Illya Rudkin 24/02/2014.
// Changes:	None.
//--
class CMICmnMIValueTuple : public CMICmnMIValue
{
// Methods:
public:
	/* ctor */	CMICmnMIValueTuple( void );
	/* ctor */	CMICmnMIValueTuple( const CMICmnMIValueResult & vResult );
	/* ctor */	CMICmnMIValueTuple( const CMICmnMIValueResult & vResult, const bool vbUseSpacing );
	//
	bool			Add( const CMICmnMIValueResult & vResult );
	bool			Add( const CMICmnMIValueResult & vResult, const bool vbUseSpacing );
	bool			Add( const CMICmnMIValueConst & vValue, const bool vbUseSpacing );
	CMIUtilString	ExtractContentNoBrackets( void ) const; 

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

// Methods:
private:
	bool BuildTuple( void );
	bool BuildTuple( const CMICmnMIValueResult & vResult );
	bool BuildTuple( const CMIUtilString & vValue );

// Attributes:
private:
	bool m_bSpaceAfterComma;	// True = put space seperators into the string, false = no spaces used
};