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

111 lines
3.7 KiB
C++

//===-- MICmnMIOutOfBandRecord.h --------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//++
// File: MICmnMIOutOfBandRecord.h
//
// Overview: CMICmnMIOutOfBandRecord interface.
//
// 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 <map>
// In-house headers:
#include "MICmnBase.h"
#include "MIUtilString.h"
#include "MICmnMIValueResult.h"
//++ ============================================================================
// Details: MI common code MI Out-of-band (Async) Record class. A class that encapsulates
// MI result record data and the forming/format of data added to it.
// Out-of-band records are used to notify the GDB/MI client of additional
// changes that have occurred. Those changes can either be a consequence
// of GDB/MI (e.g., a breakpoint modified) or a result of target activity
// (e.g., target stopped).
// The syntax is as follows:
// "*" type ( "," result )*
// type ==> running | stopped
//
// The Out-of-band record can be retrieve at any time *this object is
// instantiated so unless work is done on *this Out-of-band record then it is
// possible to return a malformed Out-of-band record. If nothing has been set
// or added to *this MI Out-of-band record object then text "<Invalid>" will
// be returned.
//
// 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 CMICmnMIOutOfBandRecord : public CMICmnBase
{
// Enumerations:
public:
//++
// Details: Enumeration of the type of Out-of-band for *this Out-of-band record
//--
enum OutOfBand_e
{
eOutOfBand_Running = 0,
eOutOfBand_Stopped,
eOutOfBand_BreakPointCreated,
eOutOfBand_BreakPointModified,
eOutOfBand_Thread,
eOutOfBand_ThreadGroupAdded,
eOutOfBand_ThreadGroupExited,
eOutOfBand_ThreadGroupRemoved,
eOutOfBand_ThreadGroupStarted,
eOutOfBand_ThreadCreated,
eOutOfBand_ThreadExited,
eOutOfBand_ThreadSelected,
eOutOfBand_count // Always the last one
};
// Typedefs:
public:
typedef std::map<OutOfBand_e, CMIUtilString> MapOutOfBandToOutOfBandText_t;
typedef std::map<OutOfBand_e, CMIUtilString> MapOutOfBandToToken_t;
// Methods:
public:
/* ctor */ CMICmnMIOutOfBandRecord(void);
/* ctor */ CMICmnMIOutOfBandRecord(const OutOfBand_e veType);
/* ctor */ CMICmnMIOutOfBandRecord(const OutOfBand_e veType, const CMICmnMIValueResult &vValue);
//
const CMIUtilString &GetString(void) const;
bool Add(const CMICmnMIValue &vMIValue);
// Overridden:
public:
// From CMICmnBase
/* dtor */ virtual ~CMICmnMIOutOfBandRecord(void);
// Methods:
private:
bool BuildAsyncRecord(void);
// Attributes:
private:
static MapOutOfBandToOutOfBandText_t ms_constMapOutOfBandToAsyncRecordText;
static MapOutOfBandToToken_t ms_constMapOutOfBandTextToToken;
//
OutOfBand_e m_eResultAsyncRecordClass;
CMIUtilString m_strAsyncRecord; // Holds the text version of the result record to date
CMICmnMIValueResult m_partResult;
};