LLDB mainline
Public Member Functions | Private Types | Private Attributes | List of all members
lldb_private::CommandReturnObject Class Reference

#include <CommandReturnObject.h>

Public Member Functions

 CommandReturnObject (bool colors)
 
 ~CommandReturnObject ()=default
 
std::string GetInlineDiagnosticString (unsigned indent)
 Format any inline diagnostics with an indentation of indent.
 
llvm::StringRef GetOutputString ()
 
std::string GetErrorString (bool with_diagnostics=true)
 Return the errors as a string.
 
StructuredData::ObjectSP GetErrorData ()
 
StreamGetOutputStream ()
 
StreamGetErrorStream ()
 
void SetImmediateOutputFile (lldb::FileSP file_sp)
 
void SetImmediateErrorFile (lldb::FileSP file_sp)
 
void SetImmediateOutputStream (const lldb::StreamSP &stream_sp)
 
void SetImmediateErrorStream (const lldb::StreamSP &stream_sp)
 
lldb::StreamSP GetImmediateOutputStream ()
 
lldb::StreamSP GetImmediateErrorStream ()
 
void Clear ()
 
void AppendMessage (llvm::StringRef in_string)
 
void AppendMessageWithFormat (const char *format,...) __attribute__((format(printf
 
void void AppendNote (llvm::StringRef in_string)
 
void AppendNoteWithFormat (const char *format,...) __attribute__((format(printf
 
void void AppendWarning (llvm::StringRef in_string)
 
void AppendWarningWithFormat (const char *format,...) __attribute__((format(printf
 
void void AppendError (llvm::StringRef in_string)
 
void AppendRawError (llvm::StringRef in_string)
 
void AppendErrorWithFormat (const char *format,...) __attribute__((format(printf
 
template<typename... Args>
void void AppendMessageWithFormatv (const char *format, Args &&... args)
 
template<typename... Args>
void AppendNoteWithFormatv (const char *format, Args &&...args)
 
template<typename... Args>
void AppendWarningWithFormatv (const char *format, Args &&... args)
 
template<typename... Args>
void AppendErrorWithFormatv (const char *format, Args &&... args)
 
void SetError (Status error)
 
void SetError (llvm::Error error)
 
void SetDiagnosticIndent (std::optional< uint16_t > indent)
 
std::optional< uint16_t > GetDiagnosticIndent () const
 
lldb::ReturnStatus GetStatus () const
 
void SetStatus (lldb::ReturnStatus status)
 
bool Succeeded () const
 
bool HasResult () const
 
bool GetDidChangeProcessState () const
 
void SetDidChangeProcessState (bool b)
 
bool GetInteractive () const
 
void SetInteractive (bool b)
 
bool GetSuppressImmediateOutput () const
 
void SetSuppressImmediateOutput (bool b)
 

Private Types

enum  { eStreamStringIndex = 0 , eImmediateStreamIndex = 1 }
 

Private Attributes

StreamTee m_out_stream
 
StreamTee m_err_stream
 
std::vector< DiagnosticDetailm_diagnostics
 
std::optional< uint16_t > m_diagnostic_indent
 
lldb::ReturnStatus m_status = lldb::eReturnStatusStarted
 
bool m_did_change_process_state = false
 
bool m_suppress_immediate_output = false
 
bool m_interactive = true
 If true, then the input handle from the debugger will be hooked up.
 
bool m_colors
 

Detailed Description

Definition at line 28 of file CommandReturnObject.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
eStreamStringIndex 
eImmediateStreamIndex 

Definition at line 183 of file CommandReturnObject.h.

Constructor & Destructor Documentation

◆ CommandReturnObject()

CommandReturnObject::CommandReturnObject ( bool  colors)

Definition at line 50 of file CommandReturnObject.cpp.

◆ ~CommandReturnObject()

lldb_private::CommandReturnObject::~CommandReturnObject ( )
default

Member Function Documentation

◆ AppendError()

void CommandReturnObject::AppendError ( llvm::StringRef  in_string)

Definition at line 125 of file CommandReturnObject.cpp.

References lldb::eReturnStatusFailed, error(), GetErrorStream(), and SetStatus().

Referenced by CommandObjectTargetSymbolsAdd::AddModuleSymbols(), CommandObjectTargetSymbolsAdd::AddSymbolsForFile(), CommandObjectTargetSymbolsAdd::AddSymbolsForFrame(), CommandObjectTargetSymbolsAdd::AddSymbolsForStack(), CommandObjectTargetSymbolsAdd::AddSymbolsForUUID(), AppendErrorWithFormatv(), lldb_private::CommandInterpreter::BuildAliasResult(), lldb_private::CommandObject::CheckRequirements(), CheckTargetForWatchpointOperations(), lldb_private::ScriptInterpreter::CollectDataForBreakpointCommandCallback(), lldb_private::ScriptInterpreter::CollectDataForWatchpointCommandCallback(), CommandObjectTypeCategoryDisable::CommandObjectTypeCategoryDisable(), CommandObjectCommandsUnalias::DoExecute(), CommandObjectCommandsDelete::DoExecute(), CommandObjectScriptingObjectParsed::DoExecute(), CommandObjectDiagnosticsDump::DoExecute(), lldb_private::CommandObjectGUI::DoExecute(), CommandObjectLogEnable::DoExecute(), CommandObjectLogTimerEnable::DoExecute(), CommandObjectLogTimerDisable::DoExecute(), CommandObjectLogTimerDump::DoExecute(), CommandObjectLogTimerReset::DoExecute(), CommandObjectLogTimerIncrement::DoExecute(), CommandObjectPlatformSelect::DoExecute(), CommandObjectPlatformList::DoExecute(), CommandObjectPlatformStatus::DoExecute(), CommandObjectPlatformConnect::DoExecute(), CommandObjectPlatformDisconnect::DoExecute(), CommandObjectPlatformSettings::DoExecute(), CommandObjectPlatformMkDir::DoExecute(), CommandObjectPlatformFOpen::DoExecute(), CommandObjectPlatformFClose::DoExecute(), CommandObjectPlatformFRead::DoExecute(), CommandObjectPlatformFWrite::DoExecute(), CommandObjectPlatformProcessLaunch::DoExecute(), CommandObjectPlatformProcessList::DoExecute(), CommandObjectPlatformProcessInfo::DoExecute(), CommandObjectPlatformInstall::DoExecute(), lldb_private::CommandObjectQuit::DoExecute(), CommandObjectSettingsShow::DoExecute(), CommandObjectSettingsWrite::DoExecute(), CommandObjectTargetSelect::DoExecute(), CommandObjectTargetDelete::DoExecute(), CommandObjectTargetVariable::DoExecute(), CommandObjectTargetModulesAdd::DoExecute(), CommandObjectTargetModulesLoad::DoExecute(), CommandObjectTargetSymbolsAdd::DoExecute(), CommandObjectTraceDumpFunctionCalls::DoExecute(), CommandObjectTraceDumpInstructions::DoExecute(), lldb_private::CommandObjectApropos::DoExecute(), CommandObjectBreakpointSet::DoExecute(), CommandObjectBreakpointEnable::DoExecute(), CommandObjectBreakpointList::DoExecute(), CommandObjectBreakpointClear::DoExecute(), CommandObjectBreakpointDelete::DoExecute(), CommandObjectBreakpointNameConfigure::DoExecute(), CommandObjectBreakpointNameAdd::DoExecute(), CommandObjectBreakpointNameDelete::DoExecute(), CommandObjectBreakpointRead::DoExecute(), CommandObjectBreakpointCommandDelete::DoExecute(), CommandObjectBreakpointCommandList::DoExecute(), CommandObjectCommandsSource::DoExecute(), CommandObjectCommandsScriptImport::DoExecute(), CommandObjectCommandsScriptAdd::DoExecute(), CommandObjectCommandsContainerAdd::DoExecute(), CommandObjectCommandsContainerDelete::DoExecute(), lldb_private::CommandObjectDisassemble::DoExecute(), CommandObjectFrameDiagnose::DoExecute(), CommandObjectFrameSelect::DoExecute(), CommandObjectFrameVariable::DoExecute(), CommandObjectFrameRecognizerInfo::DoExecute(), lldb_private::CommandObjectHelp::DoExecute(), CommandObjectMemoryRead::DoExecute(), CommandObjectMemoryFind::DoExecute(), CommandObjectMemoryWrite::DoExecute(), CommandObjectMemoryHistory::DoExecute(), CommandObjectMemoryRegion::DoExecute(), CommandObjectMemoryTagRead::DoExecute(), CommandObjectMemoryTagWrite::DoExecute(), CommandObjectPlatformProcessAttach::DoExecute(), CommandObjectPluginLoad::DoExecute(), CommandObjectProcessAttach::DoExecute(), CommandObjectProcessContinue::DoExecute(), CommandObjectProcessConnect::DoExecute(), CommandObjectProcessInterrupt::DoExecute(), CommandObjectProcessKill::DoExecute(), CommandObjectProcessSaveCore::DoExecute(), CommandObjectProcessStatus::DoExecute(), CommandObjectProcessTraceStop::DoExecute(), CommandObjectRegisterRead::DoExecute(), CommandObjectRegisterWrite::DoExecute(), CommandObjectRegisterInfo::DoExecute(), CommandObjectSessionHistory::DoExecute(), CommandObjectSettingsClear::DoExecute(), CommandObjectSourceInfo::DoExecute(), CommandObjectStatsEnable::DoExecute(), CommandObjectStatsDisable::DoExecute(), CommandObjectTargetCreate::DoExecute(), CommandObjectTargetModulesSearchPathsAdd::DoExecute(), CommandObjectTargetModulesSearchPathsInsert::DoExecute(), CommandObjectTargetModulesSearchPathsQuery::DoExecute(), CommandObjectTargetModulesDumpObjfile::DoExecute(), CommandObjectTargetModulesDumpSymtab::DoExecute(), CommandObjectTargetModulesDumpSections::DoExecute(), CommandObjectTargetModulesDumpClangPCMInfo::DoExecute(), CommandObjectTargetModulesDumpClangAST::DoExecute(), CommandObjectTargetModulesDumpSymfile::DoExecute(), CommandObjectTargetModulesDumpLineTable::DoExecute(), CommandObjectTargetModulesDumpSeparateDebugInfoFiles::DoExecute(), CommandObjectTargetModulesList::DoExecute(), CommandObjectTargetModulesShowUnwind::DoExecute(), CommandObjectTargetModulesLookup::DoExecute(), CommandObjectThreadStepWithTypeAndScope::DoExecute(), CommandObjectThreadContinue::DoExecute(), CommandObjectThreadUntil::DoExecute(), CommandObjectThreadSelect::DoExecute(), CommandObjectThreadPlanList::DoExecute(), CommandObjectTraceSave::DoExecute(), CommandObjectTraceLoad::DoExecute(), CommandObjectTraceSchema::DoExecute(), CommandObjectTypeSynthAdd::DoExecute(), CommandObjectTypeFormatterDelete::DoExecute(), CommandObjectWatchpointList::DoExecute(), CommandObjectWatchpointEnable::DoExecute(), CommandObjectWatchpointDisable::DoExecute(), CommandObjectWatchpointDelete::DoExecute(), CommandObjectWatchpointIgnore::DoExecute(), CommandObjectWatchpointModify::DoExecute(), CommandObjectWatchpointCommandDelete::DoExecute(), CommandObjectWatchpointCommandList::DoExecute(), CommandObjectObjC_ClassTable_Dump::DoExecute(), CommandObjectMultiwordObjC_TaggedPointer_Info::DoExecute(), CommandObjectProcessKDPPacketSend::DoExecute(), sddarwinlog_private::EnableCommand::DoExecute(), CommandObjectProcessLaunch::DoExecute(), CommandObjectProcessHandle::DoExecute(), lldb_private::CommandObjectDWIMPrint::DoExecute(), lldb_private::CommandObjectRegexCommand::DoExecute(), CommandObjectScriptingRun::DoExecute(), CommandObjectSettingsRemove::DoExecute(), CommandObjectSettingsReplace::DoExecute(), CommandObjectSettingsInsertBefore::DoExecute(), CommandObjectSettingsInsertAfter::DoExecute(), CommandObjectSettingsAppend::DoExecute(), CommandObjectThreadReturn::DoExecute(), CommandObjectPythonFunction::DoExecute(), CommandObjectScriptingObjectRaw::DoExecute(), CommandObjectPlatformShell::DoExecute(), CommandObjectTraceStop::DoExecuteOnThreads(), CommandObjectSourceInfo::DumpLinesForFrame(), lldb_private::CommandObjectMultiword::Execute(), lldb_private::CommandObjectProxy::Execute(), CommandObjectTypeSummaryAdd::Execute_StringSummary(), lldb_private::ScriptInterpreterLua::ExecuteOneLine(), CommandObjectBreakpointSet::GetDefaultFile(), lldb_private::CommandInterpreter::HandleCommand(), lldb::SBCommandInterpreter::HandleCommand(), lldb::SBCommandInterpreter::HandleCommandsFromFile(), CommandObjectThreadException::HandleOneThread(), CommandObjectThreadSiginfo::HandleOneThread(), lldb_private::CommandObject::ParseOptionsAndNotify(), ProcessAliasOptionsArgs(), lldb::SBCommandInterpreter::ResolveCommand(), lldb_private::CommandInterpreter::SaveTranscript(), lldb::SBCommandReturnObject::SetError(), SetError(), lldb_private::CommandInterpreter::SourceInitFileCwd(), lldb::SBCommandInterpreter::SourceInitFileInCurrentWorkingDirectory(), lldb::SBCommandInterpreter::SourceInitFileInGlobalDirectory(), lldb::SBCommandInterpreter::SourceInitFileInHomeDirectory(), lldb_private::CommandObjectMultiwordBreakpoint::VerifyIDs(), lldb_private::Options::VerifyOptions(), and CommandObjectTypeFormat::~CommandObjectTypeFormat().

◆ AppendErrorWithFormat()

void CommandReturnObject::AppendErrorWithFormat ( const char *  format,
  ... 
)

Definition at line 53 of file CommandReturnObject.cpp.

References DumpStringToStreamWithNewline(), lldb::eReturnStatusFailed, error(), GetErrorStream(), lldb_private::StreamString::GetString(), lldb_private::Stream::PrintfVarArg(), and SetStatus().

Referenced by CommandObjectTargetSymbolsAdd::AddModuleSymbols(), CommandObjectTargetSymbolsAdd::AddSymbolsForFrame(), CommandObjectTargetSymbolsAdd::AddSymbolsForStack(), CommandObjectTypeSynthAdd::AddSynth(), lldb_private::CommandInterpreter::BuildAliasCommandArgs(), lldb_private::CommandInterpreter::BuildAliasResult(), CommandObjectScriptingObjectParsed::Create(), CommandObjectSourceList::DisplayFunctionSource(), CommandObjectCommandsUnalias::DoExecute(), CommandObjectCommandsDelete::DoExecute(), CommandObjectDiagnosticsDump::DoExecute(), CommandObjectLogEnable::DoExecute(), CommandObjectLogDisable::DoExecute(), CommandObjectLogDump::DoExecute(), CommandObjectLogTimerEnable::DoExecute(), CommandObjectLogTimerDisable::DoExecute(), CommandObjectLogTimerDump::DoExecute(), CommandObjectLogTimerReset::DoExecute(), CommandObjectLogTimerIncrement::DoExecute(), CommandObjectPlatformConnect::DoExecute(), CommandObjectPlatformDisconnect::DoExecute(), CommandObjectPlatformProcessLaunch::DoExecute(), CommandObjectPlatformProcessList::DoExecute(), CommandObjectPlatformProcessInfo::DoExecute(), CommandObjectPlatformInstall::DoExecute(), CommandObjectSettingsWrite::DoExecute(), CommandObjectSettingsList::DoExecute(), CommandObjectTargetSelect::DoExecute(), CommandObjectTargetDelete::DoExecute(), CommandObjectTargetVariable::DoExecute(), CommandObjectTargetModulesAdd::DoExecute(), CommandObjectTargetModulesLoad::DoExecute(), CommandObjectTargetSymbolsAdd::DoExecute(), CommandObjectThreadJump::DoExecute(), CommandObjectThreadPlanDiscard::DoExecute(), CommandObjectThreadPlanPrune::DoExecute(), lldb_private::ctf::CommandObjectThreadTraceExportCTF::DoExecute(), CommandObjectBreakpointSet::DoExecute(), CommandObjectBreakpointNameConfigure::DoExecute(), CommandObjectBreakpointWrite::DoExecute(), CommandObjectBreakpointCommandDelete::DoExecute(), CommandObjectBreakpointCommandList::DoExecute(), CommandObjectCommandsSource::DoExecute(), CommandObjectCommandsScriptImport::DoExecute(), CommandObjectCommandsScriptAdd::DoExecute(), CommandObjectCommandsScriptDelete::DoExecute(), CommandObjectCommandsContainerAdd::DoExecute(), CommandObjectCommandsContainerDelete::DoExecute(), lldb_private::CommandObjectDisassemble::DoExecute(), CommandObjectFrameSelect::DoExecute(), CommandObjectFrameVariable::DoExecute(), CommandObjectFrameRecognizerAdd::DoExecute(), CommandObjectWithFrameRecognizerArg::DoExecute(), CommandObjectFrameRecognizerInfo::DoExecute(), CommandObjectMemoryRead::DoExecute(), CommandObjectMemoryWrite::DoExecute(), CommandObjectMemoryHistory::DoExecute(), CommandObjectMemoryRegion::DoExecute(), CommandObjectMemoryTagWrite::DoExecute(), CommandObjectProcessAttach::DoExecute(), CommandObjectProcessContinue::DoExecute(), CommandObjectProcessDetach::DoExecute(), CommandObjectProcessConnect::DoExecute(), CommandObjectProcessLoad::DoExecute(), CommandObjectProcessUnload::DoExecute(), CommandObjectProcessSignal::DoExecute(), CommandObjectProcessInterrupt::DoExecute(), CommandObjectProcessKill::DoExecute(), CommandObjectProcessSaveCore::DoExecute(), CommandObjectRegisterRead::DoExecute(), CommandObjectRegisterWrite::DoExecute(), CommandObjectRegisterInfo::DoExecute(), CommandObjectSourceList::DoExecute(), CommandObjectTargetCreate::DoExecute(), CommandObjectTargetModulesSearchPathsInsert::DoExecute(), CommandObjectTargetModulesDumpClangPCMInfo::DoExecute(), CommandObjectTargetModulesList::DoExecute(), CommandObjectTargetModulesShowUnwind::DoExecute(), CommandObjectTargetStopHookDelete::DoExecute(), CommandObjectTargetStopHookEnableDisable::DoExecute(), CommandObjectThreadStepWithTypeAndScope::DoExecute(), CommandObjectThreadContinue::DoExecute(), CommandObjectThreadUntil::DoExecute(), CommandObjectThreadSelect::DoExecute(), lldb_private::CommandObjectIterateOverThreads::DoExecute(), lldb_private::CommandObjectMultipleThreads::DoExecute(), CommandObjectTraceLoad::DoExecute(), CommandObjectTraceDump::DoExecute(), CommandObjectTraceSchema::DoExecute(), CommandObjectTypeFormatterDelete::DoExecute(), CommandObjectTypeFormatterList< FormatterType >::DoExecute(), CommandObjectWatchpointCommandDelete::DoExecute(), CommandObjectWatchpointCommandList::DoExecute(), CommandObjectMultiwordItaniumABI_Demangle::DoExecute(), CommandObjectProcessGDBRemoteSpeedTest::DoExecute(), CommandObjectProcessGDBRemotePacketXferSize::DoExecute(), CommandObjectProcessGDBRemotePacketSend::DoExecute(), CommandObjectProcessKDPPacketSend::DoExecute(), CommandObjectProcessMinidumpDump::DoExecute(), CommandObjectProcessHandle::DoExecute(), CommandObjectThreadReturn::DoExecute(), CommandObjectProcessGDBRemotePacketMonitor::DoExecute(), CommandObjectFrameRecognizerEnable::DoExecuteWithId(), CommandObjectFrameRecognizerDisable::DoExecuteWithId(), CommandObjectFrameRecognizerDelete::DoExecuteWithId(), CommandObjectSourceInfo::DumpLinesForAddress(), CommandObjectSourceInfo::DumpLinesForFile(), CommandObjectSourceInfo::DumpLinesInFunctions(), lldb_private::CommandObjectMultiword::Execute(), CommandObjectTypeSummaryAdd::Execute_StringSummary(), CommandObjectTypeCategoryDisable::CommandOptions::GetDefinitions(), GetSingleThreadFromArgs(), CommandObjectTypeLookup::GuessLanguage(), lldb_private::CommandInterpreter::HandleCommand(), lldb_private::CommandInterpreter::HandleCommands(), lldb_private::CommandInterpreter::HandleCommandsFromFile(), lldb::SBCommandInterpreter::HandleCommandsFromFile(), CommandObjectThreadBacktrace::HandleOneThread(), CommandObjectThreadInfo::HandleOneThread(), CommandObjectThreadException::HandleOneThread(), CommandObjectThreadSiginfo::HandleOneThread(), lldb_private::CommandInterpreter::ResolveCommandImpl(), CommandObjectProcessLaunchOrAttach::StopProcessIfNecessary(), and lldb_private::CommandObjectMultiwordBreakpoint::VerifyIDs().

◆ AppendErrorWithFormatv()

template<typename... Args>
void lldb_private::CommandReturnObject::AppendErrorWithFormatv ( const char *  format,
Args &&...  args 
)
inline

◆ AppendMessage()

void CommandReturnObject::AppendMessage ( llvm::StringRef  in_string)

◆ AppendMessageWithFormat()

void CommandReturnObject::AppendMessageWithFormat ( const char *  format,
  ... 
)

Definition at line 71 of file CommandReturnObject.cpp.

References GetOutputStream(), lldb_private::StreamString::GetString(), and lldb_private::Stream::PrintfVarArg().

Referenced by CommandObjectTargetSymbolsAdd::AddModuleSymbols(), CommandObjectSourceList::DisplayFunctionSource(), CommandObjectPlatformFOpen::DoExecute(), CommandObjectPlatformFClose::DoExecute(), CommandObjectPlatformFRead::DoExecute(), CommandObjectPlatformFWrite::DoExecute(), CommandObjectPlatformProcessList::DoExecute(), CommandObjectTargetModulesLoad::DoExecute(), lldb_private::CommandObjectVersion::DoExecute(), lldb_private::CommandObjectApropos::DoExecute(), CommandObjectBreakpointEnable::DoExecute(), CommandObjectBreakpointDelete::DoExecute(), CommandObjectBreakpointNameList::DoExecute(), CommandObjectBreakpointCommandList::DoExecute(), CommandObjectMemoryFind::DoExecute(), CommandObjectProcessAttach::DoExecute(), CommandObjectProcessContinue::DoExecute(), CommandObjectProcessLoad::DoExecute(), CommandObjectProcessUnload::DoExecute(), CommandObjectProcessSaveCore::DoExecute(), CommandObjectProcessStatus::DoExecute(), CommandObjectTargetCreate::DoExecute(), CommandObjectThreadContinue::DoExecute(), CommandObjectThreadUntil::DoExecute(), CommandObjectWatchpointList::DoExecute(), CommandObjectWatchpointEnable::DoExecute(), CommandObjectWatchpointDisable::DoExecute(), CommandObjectWatchpointDelete::DoExecute(), CommandObjectWatchpointIgnore::DoExecute(), CommandObjectWatchpointModify::DoExecute(), CommandObjectWatchpointCommandList::DoExecute(), CommandObjectMultiwordItaniumABI_Demangle::DoExecute(), CommandObjectProcessLaunch::DoExecute(), CommandObjectMemoryRegion::DumpRegion(), lldb_private::CommandInterpreter::GetHelp(), lldb_private::CommandInterpreter::HandleCommands(), lldb_private::CommandInterpreter::ResolveCommand(), and lldb_private::CommandInterpreter::SaveTranscript().

◆ AppendMessageWithFormatv()

template<typename... Args>
void void lldb_private::CommandReturnObject::AppendMessageWithFormatv ( const char *  format,
Args &&...  args 
)
inline

◆ AppendNote()

void CommandReturnObject::AppendNote ( llvm::StringRef  in_string)

◆ AppendNoteWithFormat()

void CommandReturnObject::AppendNoteWithFormat ( const char *  format,
  ... 
)

◆ AppendNoteWithFormatv()

template<typename... Args>
void lldb_private::CommandReturnObject::AppendNoteWithFormatv ( const char *  format,
Args &&...  args 
)
inline

Definition at line 136 of file CommandReturnObject.h.

References AppendNote().

Referenced by lldb_private::CommandObjectDWIMPrint::DoExecute().

◆ AppendRawError()

void CommandReturnObject::AppendRawError ( llvm::StringRef  in_string)

◆ AppendWarning()

void CommandReturnObject::AppendWarning ( llvm::StringRef  in_string)

◆ AppendWarningWithFormat()

void CommandReturnObject::AppendWarningWithFormat ( const char *  format,
  ... 
)

◆ AppendWarningWithFormatv()

template<typename... Args>
void lldb_private::CommandReturnObject::AppendWarningWithFormatv ( const char *  format,
Args &&...  args 
)
inline

Definition at line 141 of file CommandReturnObject.h.

References AppendWarning().

◆ Clear()

void CommandReturnObject::Clear ( )

◆ GetDiagnosticIndent()

std::optional< uint16_t > lldb_private::CommandReturnObject::GetDiagnosticIndent ( ) const
inline

Definition at line 158 of file CommandReturnObject.h.

References m_diagnostic_indent.

◆ GetDidChangeProcessState()

bool CommandReturnObject::GetDidChangeProcessState ( ) const

◆ GetErrorData()

StructuredData::ObjectSP CommandReturnObject::GetErrorData ( )

◆ GetErrorStream()

Stream & lldb_private::CommandReturnObject::GetErrorStream ( )
inline

◆ GetErrorString()

std::string CommandReturnObject::GetErrorString ( bool  with_diagnostics = true)

◆ GetImmediateErrorStream()

lldb::StreamSP lldb_private::CommandReturnObject::GetImmediateErrorStream ( )
inline

◆ GetImmediateOutputStream()

lldb::StreamSP lldb_private::CommandReturnObject::GetImmediateOutputStream ( )
inline

◆ GetInlineDiagnosticString()

std::string CommandReturnObject::GetInlineDiagnosticString ( unsigned  indent)

◆ GetInteractive()

bool CommandReturnObject::GetInteractive ( ) const

Definition at line 270 of file CommandReturnObject.cpp.

References m_interactive.

Referenced by lldb_private::CommandInterpreter::HandleCommands().

◆ GetOutputStream()

Stream & lldb_private::CommandReturnObject::GetOutputStream ( )
inline

Definition at line 52 of file CommandReturnObject.h.

References eStreamStringIndex, lldb_private::StreamTee::GetStreamAtIndex(), m_out_stream, and lldb_private::StreamTee::SetStreamAtIndex().

Referenced by AppendMessage(), AppendMessageWithFormat(), AppendNote(), AppendNoteWithFormat(), CommandObjectTypeCategoryDefine::CommandObjectTypeCategoryDefine(), CommandObjectTypeSynth::CommandObjectTypeSynth(), CommandObjectSourceList::DisplayFunctionSource(), CommandObjectDiagnosticsDump::DoExecute(), CommandObjectLogList::DoExecute(), CommandObjectLogTimerDisable::DoExecute(), CommandObjectLogTimerDump::DoExecute(), CommandObjectPlatformSelect::DoExecute(), CommandObjectPlatformList::DoExecute(), CommandObjectPlatformStatus::DoExecute(), CommandObjectPlatformConnect::DoExecute(), CommandObjectPlatformDisconnect::DoExecute(), CommandObjectPlatformProcessLaunch::DoExecute(), CommandObjectPlatformProcessList::DoExecute(), CommandObjectPlatformProcessInfo::DoExecute(), CommandObjectSettingsShow::DoExecute(), CommandObjectSettingsList::DoExecute(), CommandObjectTargetList::DoExecute(), CommandObjectTargetSelect::DoExecute(), CommandObjectTargetDelete::DoExecute(), CommandObjectTargetShowLaunchEnvironment::DoExecute(), CommandObjectTargetVariable::DoExecute(), CommandObjectTraceDumpFunctionCalls::DoExecute(), CommandObjectTraceDumpInstructions::DoExecute(), lldb_private::CommandObjectApropos::DoExecute(), CommandObjectBreakpointSet::DoExecute(), CommandObjectBreakpointList::DoExecute(), CommandObjectBreakpointClear::DoExecute(), CommandObjectBreakpointRead::DoExecute(), CommandObjectBreakpointCommandList::DoExecute(), CommandObjectCommandsScriptDelete::DoExecute(), lldb_private::CommandObjectDisassemble::DoExecute(), CommandObjectFrameDiagnose::DoExecute(), CommandObjectFrameInfo::DoExecute(), CommandObjectFrameSelect::DoExecute(), CommandObjectFrameVariable::DoExecute(), CommandObjectFrameRecognizerList::DoExecute(), CommandObjectFrameRecognizerInfo::DoExecute(), lldb_private::CommandObjectHelp::DoExecute(), CommandObjectMemoryRead::DoExecute(), CommandObjectMemoryFind::DoExecute(), CommandObjectMemoryWrite::DoExecute(), CommandObjectMemoryHistory::DoExecute(), CommandObjectProcessConnect::DoExecute(), CommandObjectProcessStatus::DoExecute(), CommandObjectRegisterRead::DoExecute(), CommandObjectRegisterInfo::DoExecute(), CommandObjectScriptingExtensionList::DoExecute(), CommandObjectSessionHistory::DoExecute(), CommandObjectSourceInfo::DoExecute(), CommandObjectSourceList::DoExecute(), CommandObjectSourceCacheDump::DoExecute(), CommandObjectTargetModulesSearchPathsList::DoExecute(), CommandObjectTargetModulesSearchPathsQuery::DoExecute(), CommandObjectTargetModulesDumpObjfile::DoExecute(), CommandObjectTargetModulesDumpSymtab::DoExecute(), CommandObjectTargetModulesDumpSections::DoExecute(), CommandObjectTargetModulesDumpClangPCMInfo::DoExecute(), CommandObjectTargetModulesDumpClangAST::DoExecute(), CommandObjectTargetModulesDumpSymfile::DoExecute(), CommandObjectTargetModulesDumpLineTable::DoExecute(), CommandObjectTargetModulesDumpSeparateDebugInfoFiles::DoExecute(), CommandObjectTargetModulesList::DoExecute(), CommandObjectTargetModulesShowUnwind::DoExecute(), CommandObjectTargetModulesLookup::DoExecute(), CommandObjectTargetStopHookList::DoExecute(), CommandObjectTargetDumpTypesystem::DoExecute(), CommandObjectTargetDumpSectionLoadList::DoExecute(), CommandObjectThreadList::DoExecute(), CommandObjectThreadPlanList::DoExecute(), lldb_private::CommandObjectIterateOverThreads::DoExecute(), CommandObjectTypeFormatterList< FormatterType >::DoExecute(), CommandObjectWatchpointList::DoExecute(), CommandObjectWatchpointCommandList::DoExecute(), CommandObjectObjC_ClassTable_Dump::DoExecute(), CommandObjectMultiwordObjC_TaggedPointer_Info::DoExecute(), CommandObjectProcessGDBRemoteSpeedTest::DoExecute(), CommandObjectProcessGDBRemotePacketHistory::DoExecute(), CommandObjectProcessGDBRemotePacketSend::DoExecute(), CommandObjectProcessMinidumpDump::DoExecute(), sddarwinlog_private::StatusCommand::DoExecute(), CommandObjectProcessHandle::DoExecute(), lldb_private::CommandObjectDWIMPrint::DoExecute(), lldb_private::CommandObjectRegexCommand::DoExecute(), CommandObjectThreadReturn::DoExecute(), CommandObjectFormatterInfo< FormatterType >::DoExecute(), CommandObjectProcessGDBRemotePacketMonitor::DoExecute(), CommandObjectPlatformShell::DoExecute(), CommandObjectThreadBacktrace::DoExtendedBacktrace(), CommandObjectSourceInfo::DumpLinesForAddress(), CommandObjectSourceInfo::DumpLinesForFile(), CommandObjectSourceInfo::DumpLinesForFrame(), CommandObjectSourceInfo::DumpLinesInFunctions(), lldb_private::CommandObject::GenerateHelpText(), lldb_private::CommandInterpreter::GetHelp(), CommandObjectTypeCategoryDefine::GetOptions(), CommandObjectThreadBacktrace::HandleOneThread(), CommandObjectThreadInfo::HandleOneThread(), CommandObjectThreadException::HandleOneThread(), CommandObjectThreadSiginfo::HandleOneThread(), CommandObjectThreadPlanList::HandleOneThread(), CommandObjectTraceDumpInfo::HandleOneThread(), CommandObjectTargetModulesLookup::LookupHere(), CommandObjectTargetModulesLookup::LookupInModule(), and lldb_private::ScriptInterpreterIORedirect::ScriptInterpreterIORedirect().

◆ GetOutputString()

llvm::StringRef lldb_private::CommandReturnObject::GetOutputString ( )
inline

◆ GetStatus()

ReturnStatus CommandReturnObject::GetStatus ( ) const

◆ GetSuppressImmediateOutput()

bool CommandReturnObject::GetSuppressImmediateOutput ( ) const

Definition at line 274 of file CommandReturnObject.cpp.

References m_suppress_immediate_output.

◆ HasResult()

bool CommandReturnObject::HasResult ( ) const

◆ SetDiagnosticIndent()

void lldb_private::CommandReturnObject::SetDiagnosticIndent ( std::optional< uint16_t >  indent)
inline

◆ SetDidChangeProcessState()

void CommandReturnObject::SetDidChangeProcessState ( bool  b)

◆ SetError() [1/2]

void CommandReturnObject::SetError ( llvm::Error  error)

◆ SetError() [2/2]

void CommandReturnObject::SetError ( Status  error)

◆ SetImmediateErrorFile()

void lldb_private::CommandReturnObject::SetImmediateErrorFile ( lldb::FileSP  file_sp)
inline

◆ SetImmediateErrorStream()

void lldb_private::CommandReturnObject::SetImmediateErrorStream ( const lldb::StreamSP stream_sp)
inline

◆ SetImmediateOutputFile()

void lldb_private::CommandReturnObject::SetImmediateOutputFile ( lldb::FileSP  file_sp)
inline

◆ SetImmediateOutputStream()

void lldb_private::CommandReturnObject::SetImmediateOutputStream ( const lldb::StreamSP stream_sp)
inline

◆ SetInteractive()

void CommandReturnObject::SetInteractive ( bool  b)

◆ SetStatus()

void CommandReturnObject::SetStatus ( lldb::ReturnStatus  status)

Definition at line 234 of file CommandReturnObject.cpp.

References m_status.

Referenced by CommandObjectTargetSymbolsAdd::AddModuleSymbols(), AppendError(), AppendErrorWithFormat(), AppendRawError(), lldb_private::CommandInterpreter::BuildAliasCommandArgs(), CommandObjectTypeSynth::CommandObjectTypeSynth(), CommandObjectCommandsUnalias::DoExecute(), CommandObjectCommandsDelete::DoExecute(), CommandObjectScriptingObjectParsed::DoExecute(), CommandObjectDiagnosticsDump::DoExecute(), lldb_private::CommandObjectGUI::DoExecute(), CommandObjectLogEnable::DoExecute(), CommandObjectLogDisable::DoExecute(), CommandObjectLogList::DoExecute(), CommandObjectLogDump::DoExecute(), CommandObjectLogTimerEnable::DoExecute(), CommandObjectLogTimerDisable::DoExecute(), CommandObjectLogTimerDump::DoExecute(), CommandObjectLogTimerReset::DoExecute(), CommandObjectLogTimerIncrement::DoExecute(), CommandObjectPlatformSelect::DoExecute(), CommandObjectPlatformList::DoExecute(), CommandObjectPlatformStatus::DoExecute(), CommandObjectPlatformConnect::DoExecute(), CommandObjectPlatformDisconnect::DoExecute(), CommandObjectPlatformMkDir::DoExecute(), CommandObjectPlatformFOpen::DoExecute(), CommandObjectPlatformFClose::DoExecute(), CommandObjectPlatformFRead::DoExecute(), CommandObjectPlatformFWrite::DoExecute(), CommandObjectPlatformProcessLaunch::DoExecute(), CommandObjectPlatformProcessList::DoExecute(), CommandObjectPlatformInstall::DoExecute(), lldb_private::CommandObjectQuit::DoExecute(), CommandObjectSessionSave::DoExecute(), CommandObjectSettingsShow::DoExecute(), CommandObjectSettingsList::DoExecute(), CommandObjectTargetList::DoExecute(), CommandObjectTargetSelect::DoExecute(), CommandObjectTargetDelete::DoExecute(), CommandObjectTargetShowLaunchEnvironment::DoExecute(), CommandObjectTargetModulesAdd::DoExecute(), CommandObjectTargetSymbolsAdd::DoExecute(), CommandObjectThreadJump::DoExecute(), CommandObjectThreadPlanDiscard::DoExecute(), CommandObjectThreadPlanPrune::DoExecute(), lldb_private::CommandObjectVersion::DoExecute(), lldb_private::CommandObjectApropos::DoExecute(), CommandObjectBreakpointSet::DoExecute(), CommandObjectBreakpointEnable::DoExecute(), CommandObjectBreakpointList::DoExecute(), CommandObjectBreakpointClear::DoExecute(), CommandObjectBreakpointDelete::DoExecute(), CommandObjectBreakpointWrite::DoExecute(), CommandObjectBreakpointCommandList::DoExecute(), CommandObjectCommandsSource::DoExecute(), CommandObjectCommandsScriptImport::DoExecute(), CommandObjectCommandsScriptAdd::DoExecute(), CommandObjectCommandsScriptList::DoExecute(), CommandObjectCommandsScriptClear::DoExecute(), CommandObjectCommandsScriptDelete::DoExecute(), CommandObjectCommandsContainerAdd::DoExecute(), CommandObjectCommandsContainerDelete::DoExecute(), lldb_private::CommandObjectDisassemble::DoExecute(), CommandObjectFrameInfo::DoExecute(), CommandObjectFrameSelect::DoExecute(), CommandObjectFrameVariable::DoExecute(), CommandObjectFrameRecognizerAdd::DoExecute(), CommandObjectFrameRecognizerClear::DoExecute(), CommandObjectFrameRecognizerList::DoExecute(), CommandObjectFrameRecognizerInfo::DoExecute(), lldb_private::CommandObjectHelp::DoExecute(), CommandObjectMemoryRead::DoExecute(), CommandObjectMemoryFind::DoExecute(), CommandObjectMemoryWrite::DoExecute(), CommandObjectMemoryHistory::DoExecute(), CommandObjectMemoryRegion::DoExecute(), CommandObjectMemoryTagRead::DoExecute(), CommandObjectMemoryTagWrite::DoExecute(), CommandObjectPlatformProcessAttach::DoExecute(), CommandObjectPluginLoad::DoExecute(), CommandObjectProcessAttach::DoExecute(), CommandObjectProcessContinue::DoExecute(), CommandObjectProcessDetach::DoExecute(), CommandObjectProcessLoad::DoExecute(), CommandObjectProcessUnload::DoExecute(), CommandObjectProcessSignal::DoExecute(), CommandObjectProcessInterrupt::DoExecute(), CommandObjectProcessKill::DoExecute(), CommandObjectProcessSaveCore::DoExecute(), CommandObjectProcessStatus::DoExecute(), CommandObjectProcessTraceStop::DoExecute(), CommandObjectRegisterWrite::DoExecute(), CommandObjectRegisterInfo::DoExecute(), CommandObjectSessionHistory::DoExecute(), CommandObjectSettingsClear::DoExecute(), CommandObjectSourceInfo::DoExecute(), CommandObjectSourceList::DoExecute(), CommandObjectSourceCacheDump::DoExecute(), CommandObjectSourceCacheClear::DoExecute(), CommandObjectStatsEnable::DoExecute(), CommandObjectStatsDisable::DoExecute(), CommandObjectStatsDump::DoExecute(), CommandObjectTargetCreate::DoExecute(), CommandObjectTargetModulesSearchPathsAdd::DoExecute(), CommandObjectTargetModulesSearchPathsClear::DoExecute(), CommandObjectTargetModulesSearchPathsInsert::DoExecute(), CommandObjectTargetModulesSearchPathsList::DoExecute(), CommandObjectTargetModulesSearchPathsQuery::DoExecute(), CommandObjectTargetModulesDumpObjfile::DoExecute(), CommandObjectTargetModulesDumpSymtab::DoExecute(), CommandObjectTargetModulesDumpSections::DoExecute(), CommandObjectTargetModulesDumpClangPCMInfo::DoExecute(), CommandObjectTargetModulesDumpClangAST::DoExecute(), CommandObjectTargetModulesDumpSymfile::DoExecute(), CommandObjectTargetModulesDumpLineTable::DoExecute(), CommandObjectTargetModulesDumpSeparateDebugInfoFiles::DoExecute(), CommandObjectTargetModulesList::DoExecute(), CommandObjectTargetModulesLookup::DoExecute(), CommandObjectTargetStopHookDelete::DoExecute(), CommandObjectTargetStopHookEnableDisable::DoExecute(), CommandObjectTargetStopHookList::DoExecute(), CommandObjectTargetDumpTypesystem::DoExecute(), CommandObjectTargetDumpSectionLoadList::DoExecute(), CommandObjectThreadStepWithTypeAndScope::DoExecute(), CommandObjectThreadContinue::DoExecute(), CommandObjectThreadUntil::DoExecute(), CommandObjectThreadSelect::DoExecute(), CommandObjectThreadList::DoExecute(), CommandObjectThreadPlanList::DoExecute(), lldb_private::CommandObjectIterateOverThreads::DoExecute(), CommandObjectTraceSave::DoExecute(), CommandObjectTraceLoad::DoExecute(), CommandObjectTraceDump::DoExecute(), CommandObjectTraceSchema::DoExecute(), CommandObjectTypeFormatterDelete::DoExecute(), CommandObjectTypeFormatterClear::DoExecute(), CommandObjectTypeFormatterList< FormatterType >::DoExecute(), CommandObjectWatchpointList::DoExecute(), CommandObjectWatchpointEnable::DoExecute(), CommandObjectWatchpointDisable::DoExecute(), CommandObjectWatchpointDelete::DoExecute(), CommandObjectWatchpointIgnore::DoExecute(), CommandObjectWatchpointModify::DoExecute(), CommandObjectWatchpointCommandDelete::DoExecute(), CommandObjectWatchpointCommandList::DoExecute(), CommandObjectMultiwordItaniumABI_Demangle::DoExecute(), CommandObjectObjC_ClassTable_Dump::DoExecute(), CommandObjectMultiwordObjC_TaggedPointer_Info::DoExecute(), CommandObjectProcessGDBRemoteSpeedTest::DoExecute(), CommandObjectProcessGDBRemotePacketHistory::DoExecute(), CommandObjectProcessGDBRemotePacketXferSize::DoExecute(), CommandObjectProcessGDBRemotePacketSend::DoExecute(), CommandObjectProcessKDPPacketSend::DoExecute(), CommandObjectProcessMinidumpDump::DoExecute(), sddarwinlog_private::EnableCommand::DoExecute(), sddarwinlog_private::StatusCommand::DoExecute(), lldb_private::trace_intel_pt::CommandObjectProcessTraceStartIntelPT::DoExecute(), CommandObjectProcessLaunch::DoExecute(), CommandObjectProcessHandle::DoExecute(), lldb_private::CommandObjectDWIMPrint::DoExecute(), lldb_private::CommandObjectRegexCommand::DoExecute(), CommandObjectScriptingRun::DoExecute(), CommandObjectSettingsRemove::DoExecute(), CommandObjectSettingsReplace::DoExecute(), CommandObjectSettingsInsertBefore::DoExecute(), CommandObjectSettingsInsertAfter::DoExecute(), CommandObjectSettingsAppend::DoExecute(), CommandObjectThreadReturn::DoExecute(), CommandObjectProcessGDBRemotePacketMonitor::DoExecute(), CommandObjectPythonFunction::DoExecute(), CommandObjectScriptingObjectRaw::DoExecute(), CommandObjectPlatformShell::DoExecute(), CommandObjectTraceStop::DoExecuteOnThreads(), lldb_private::trace_intel_pt::CommandObjectThreadTraceStartIntelPT::DoExecuteOnThreads(), CommandObjectFrameRecognizerEnable::DoExecuteWithId(), CommandObjectFrameRecognizerDisable::DoExecuteWithId(), CommandObjectFrameRecognizerDelete::DoExecuteWithId(), CommandObjectTypeSummaryAdd::Execute_StringSummary(), lldb_private::CommandObject::GenerateHelpText(), lldb_private::CommandInterpreter::HandleCommand(), lldb_private::CommandInterpreter::HandleCommands(), lldb_private::CommandInterpreter::HandleCommandsFromFile(), CommandObjectTargetModulesLookup::LookupHere(), CommandObjectTargetModulesLookup::LookupInModule(), lldb_private::CommandObject::ParseOptions(), lldb_private::CommandInterpreter::ResolveCommand(), lldb_private::CommandInterpreter::SaveTranscript(), SetError(), lldb::SBCommandReturnObject::SetStatus(), lldb_private::CommandInterpreter::SourceInitFile(), lldb_private::CommandInterpreter::SourceInitFileCwd(), lldb_private::CommandInterpreter::SourceInitFileGlobal(), lldb_private::CommandInterpreter::SourceInitFileHome(), CommandObjectProcessLaunchOrAttach::StopProcessIfNecessary(), lldb_private::CommandObjectMultiwordBreakpoint::VerifyIDs(), lldb_private::Options::VerifyOptions(), and CommandObjectTypeCategoryDisable::~CommandObjectTypeCategoryDisable().

◆ SetSuppressImmediateOutput()

void CommandReturnObject::SetSuppressImmediateOutput ( bool  b)

◆ Succeeded()

bool CommandReturnObject::Succeeded ( ) const

Member Data Documentation

◆ m_colors

bool lldb_private::CommandReturnObject::m_colors
private

Definition at line 197 of file CommandReturnObject.h.

Referenced by GetErrorString(), and GetInlineDiagnosticString().

◆ m_diagnostic_indent

std::optional<uint16_t> lldb_private::CommandReturnObject::m_diagnostic_indent
private

Definition at line 188 of file CommandReturnObject.h.

Referenced by GetDiagnosticIndent(), and SetDiagnosticIndent().

◆ m_diagnostics

std::vector<DiagnosticDetail> lldb_private::CommandReturnObject::m_diagnostics
private

◆ m_did_change_process_state

bool lldb_private::CommandReturnObject::m_did_change_process_state = false
private

◆ m_err_stream

StreamTee lldb_private::CommandReturnObject::m_err_stream
private

◆ m_interactive

bool lldb_private::CommandReturnObject::m_interactive = true
private

If true, then the input handle from the debugger will be hooked up.

Definition at line 196 of file CommandReturnObject.h.

Referenced by Clear(), GetInteractive(), and SetInteractive().

◆ m_out_stream

StreamTee lldb_private::CommandReturnObject::m_out_stream
private

◆ m_status

lldb::ReturnStatus lldb_private::CommandReturnObject::m_status = lldb::eReturnStatusStarted
private

Definition at line 190 of file CommandReturnObject.h.

Referenced by Clear(), GetStatus(), HasResult(), SetStatus(), and Succeeded().

◆ m_suppress_immediate_output

bool lldb_private::CommandReturnObject::m_suppress_immediate_output = false
private

The documentation for this class was generated from the following files: