CommandReturnObject.h

Go to the documentation of this file.

//===-- CommandReturnObject.h -----------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_INTERPRETER_COMMANDRETURNOBJECT_H
#define LLDB_INTERPRETER_COMMANDRETURNOBJECT_H
 
#include "lldb/Host/StreamFile.h"
#include "lldb/Host/common/DiagnosticsRendering.h"
#include "lldb/Utility/StreamString.h"
#include "lldb/Utility/StreamTee.h"
#include "lldb/Utility/StructuredData.h"
#include "lldb/ValueObject/ValueObjectList.h"
#include "lldb/lldb-private.h"
 
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/WithColor.h"
 
#include <memory>
 
namespace lldb_private {
 
class CommandReturnObject {
public:
  CommandReturnObject(bool colors);
 
  ~CommandReturnObject() = default;
 
  /// Get the command as the user typed it. Empty string if commands were run on
  /// behalf of lldb.
  const std::string &GetCommand() const { return m_command; }
 
  void SetCommand(std::string command) { m_command = std::move(command); }
 
  /// Format any inline diagnostics with an indentation of \c indent.
  std::string GetInlineDiagnosticString(unsigned indent) const;
 
  llvm::StringRef GetOutputString() const {
    lldb::StreamSP stream_sp(m_out_stream.GetStreamAtIndex(eStreamStringIndex));
    if (stream_sp)
      return std::static_pointer_cast<StreamString>(stream_sp)->GetString();
    return llvm::StringRef();
  }
 
  /// Return the errors as a string.
  ///
  /// If \c with_diagnostics is true, all diagnostics are also
  /// rendered into the string. Otherwise the expectation is that they
  /// are fetched with \ref GetInlineDiagnosticString().
  std::string GetErrorString(bool with_diagnostics = true) const;
  StructuredData::ObjectSP GetErrorData();
 
  Stream &GetOutputStream() {
    // Make sure we at least have our normal string stream output stream
    lldb::StreamSP stream_sp(m_out_stream.GetStreamAtIndex(eStreamStringIndex));
    if (!stream_sp) {
      stream_sp = std::make_shared<StreamString>();
      m_out_stream.SetStreamAtIndex(eStreamStringIndex, stream_sp);
    }
    return m_out_stream;
  }
 
  Stream &GetErrorStream() {
    // Make sure we at least have our normal string stream output stream
    lldb::StreamSP stream_sp(m_err_stream.GetStreamAtIndex(eStreamStringIndex));
    if (!stream_sp) {
      stream_sp = std::make_shared<StreamString>();
      m_err_stream.SetStreamAtIndex(eStreamStringIndex, stream_sp);
    }
    return m_err_stream;
  }
 
  void SetImmediateOutputFile(lldb::FileSP file_sp) {
    if (m_suppress_immediate_output)
      return;
    lldb::StreamSP stream_sp(new StreamFile(file_sp));
    m_out_stream.SetStreamAtIndex(eImmediateStreamIndex, stream_sp);
  }
 
  void SetImmediateErrorFile(lldb::FileSP file_sp) {
    if (m_suppress_immediate_output)
      return;
    lldb::StreamSP stream_sp(new StreamFile(file_sp));
    m_err_stream.SetStreamAtIndex(eImmediateStreamIndex, stream_sp);
  }
 
  void SetImmediateOutputStream(const lldb::StreamSP &stream_sp) {
    if (m_suppress_immediate_output)
      return;
    m_out_stream.SetStreamAtIndex(eImmediateStreamIndex, stream_sp);
  }
 
  void SetImmediateErrorStream(const lldb::StreamSP &stream_sp) {
    if (m_suppress_immediate_output)
      return;
    m_err_stream.SetStreamAtIndex(eImmediateStreamIndex, stream_sp);
  }
 
  lldb::StreamSP GetImmediateOutputStream() const {
    return m_out_stream.GetStreamAtIndex(eImmediateStreamIndex);
  }
 
  lldb::StreamSP GetImmediateErrorStream() const {
    return m_err_stream.GetStreamAtIndex(eImmediateStreamIndex);
  }
 
  void Clear();
 
  void AppendMessage(llvm::StringRef in_string);
 
  void AppendNote(llvm::StringRef in_string);
 
  void AppendWarning(llvm::StringRef in_string);
 
  void AppendError(llvm::StringRef in_string);
 
  void AppendErrorWithFormat(const char *format, ...)
      __attribute__((format(printf, 2, 3)));
 
  template <typename... Args>
  void AppendMessageWithFormatv(const char *format, Args &&...args) {
    AppendMessage(llvm::formatv(format, std::forward<Args>(args)...).str());
  }
 
  template <typename... Args>
  void AppendNoteWithFormatv(const char *format, Args &&...args) {
    AppendNote(llvm::formatv(format, std::forward<Args>(args)...).str());
  }
 
  template <typename... Args>
  void AppendWarningWithFormatv(const char *format, Args &&...args) {
    AppendWarning(llvm::formatv(format, std::forward<Args>(args)...).str());
  }
 
  template <typename... Args>
  void AppendErrorWithFormatv(const char *format, Args &&...args) {
    AppendError(llvm::formatv(format, std::forward<Args>(args)...).str());
  }
 
  void SetError(Status error);
 
  void SetError(llvm::Error error);
 
  void SetDiagnosticIndent(std::optional<uint16_t> indent) {
    m_diagnostic_indent = indent;
  }
 
  std::optional<uint16_t> GetDiagnosticIndent() const {
    return m_diagnostic_indent;
  }
 
  const ValueObjectList &GetValueObjectList() const { return m_value_objects; }
 
  ValueObjectList &GetValueObjectList() { return m_value_objects; }
 
  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:
  enum { eStreamStringIndex = 0, eImmediateStreamIndex = 1 };
 
  std::string m_command;
 
  StreamTee m_out_stream;
  StreamTee m_err_stream;
  std::vector<DiagnosticDetail> m_diagnostics;
  std::optional<uint16_t> m_diagnostic_indent;
 
  lldb::ReturnStatus m_status = lldb::eReturnStatusStarted;
 
  /// An optionally empty list of values produced by this command.
  ValueObjectList m_value_objects;
 
  bool m_did_change_process_state = false;
  bool m_suppress_immediate_output = false;
 
  /// If true, then the input handle from the debugger will be hooked up.
  bool m_interactive = true;
  bool m_colors;
};
 
} // namespace lldb_private
 
#endif // LLDB_INTERPRETER_COMMANDRETURNOBJECT_H