teak-llvm/lldb/source/Interpreter/CommandReturnObject.cpp
Adrian Prantl 05097246f3 Reflow paragraphs in comments.
This is intended as a clean up after the big clang-format commit
(r280751), which unfortunately resulted in many of the comment
paragraphs in LLDB being very hard to read.

FYI, the script I used was:

import textwrap
import commands
import os
import sys
import re
tmp = "%s.tmp"%sys.argv[1]
out = open(tmp, "w+")
with open(sys.argv[1], "r") as f:
  header = ""
  text = ""
  comment = re.compile(r'^( *//) ([^ ].*)$')
  special = re.compile(r'^((([A-Z]+[: ])|([0-9]+ )).*)|(.*;)$')
  for line in f:
      match = comment.match(line)
      if match and not special.match(match.group(2)):
          # skip intentionally short comments.
          if not text and len(match.group(2)) < 40:
              out.write(line)
              continue

          if text:
              text += " " + match.group(2)
          else:
              header = match.group(1)
              text = match.group(2)

          continue

      if text:
          filled = textwrap.wrap(text, width=(78-len(header)),
                                 break_long_words=False)
          for l in filled:
              out.write(header+" "+l+'\n')
              text = ""

      out.write(line)

os.rename(tmp, sys.argv[1])

Differential Revision: https://reviews.llvm.org/D46144

llvm-svn: 331197
2018-04-30 16:49:04 +00:00

176 lines
4.9 KiB
C++

//===-- CommandReturnObject.cpp ---------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "lldb/Interpreter/CommandReturnObject.h"
// C Includes
// C++ Includes
// Other libraries and framework includes
// Project includes
#include "lldb/Utility/Status.h"
#include "lldb/Utility/StreamString.h"
using namespace lldb;
using namespace lldb_private;
static void DumpStringToStreamWithNewline(Stream &strm, const std::string &s,
bool add_newline_if_empty) {
bool add_newline = false;
if (s.empty()) {
add_newline = add_newline_if_empty;
} else {
// We already checked for empty above, now make sure there is a newline in
// the error, and if there isn't one, add one.
strm.Write(s.c_str(), s.size());
const char last_char = *s.rbegin();
add_newline = last_char != '\n' && last_char != '\r';
}
if (add_newline)
strm.EOL();
}
CommandReturnObject::CommandReturnObject()
: m_out_stream(), m_err_stream(), m_status(eReturnStatusStarted),
m_did_change_process_state(false), m_interactive(true),
m_abnormal_stop_was_expected(false) {}
CommandReturnObject::~CommandReturnObject() {}
void CommandReturnObject::AppendErrorWithFormat(const char *format, ...) {
if (!format)
return;
va_list args;
va_start(args, format);
StreamString sstrm;
sstrm.PrintfVarArg(format, args);
va_end(args);
const std::string &s = sstrm.GetString();
if (!s.empty()) {
Stream &error_strm = GetErrorStream();
error_strm.PutCString("error: ");
DumpStringToStreamWithNewline(error_strm, s, false);
}
}
void CommandReturnObject::AppendMessageWithFormat(const char *format, ...) {
if (!format)
return;
va_list args;
va_start(args, format);
StreamString sstrm;
sstrm.PrintfVarArg(format, args);
va_end(args);
GetOutputStream() << sstrm.GetString();
}
void CommandReturnObject::AppendWarningWithFormat(const char *format, ...) {
if (!format)
return;
va_list args;
va_start(args, format);
StreamString sstrm;
sstrm.PrintfVarArg(format, args);
va_end(args);
GetErrorStream() << "warning: " << sstrm.GetString();
}
void CommandReturnObject::AppendMessage(llvm::StringRef in_string) {
if (in_string.empty())
return;
GetOutputStream() << in_string << "\n";
}
void CommandReturnObject::AppendWarning(llvm::StringRef in_string) {
if (in_string.empty())
return;
GetErrorStream() << "warning: " << in_string << "\n";
}
// Similar to AppendWarning, but do not prepend 'warning: ' to message, and
// don't append "\n" to the end of it.
void CommandReturnObject::AppendRawWarning(llvm::StringRef in_string) {
if (in_string.empty())
return;
GetErrorStream() << in_string;
}
void CommandReturnObject::AppendError(llvm::StringRef in_string) {
if (in_string.empty())
return;
GetErrorStream() << "error: " << in_string << "\n";
}
void CommandReturnObject::SetError(const Status &error,
const char *fallback_error_cstr) {
const char *error_cstr = error.AsCString();
if (error_cstr == nullptr)
error_cstr = fallback_error_cstr;
SetError(error_cstr);
}
void CommandReturnObject::SetError(llvm::StringRef error_str) {
if (error_str.empty())
return;
AppendError(error_str);
SetStatus(eReturnStatusFailed);
}
// Similar to AppendError, but do not prepend 'Status: ' to message, and don't
// append "\n" to the end of it.
void CommandReturnObject::AppendRawError(llvm::StringRef in_string) {
if (in_string.empty())
return;
GetErrorStream() << in_string;
}
void CommandReturnObject::SetStatus(ReturnStatus status) { m_status = status; }
ReturnStatus CommandReturnObject::GetStatus() { return m_status; }
bool CommandReturnObject::Succeeded() {
return m_status <= eReturnStatusSuccessContinuingResult;
}
bool CommandReturnObject::HasResult() {
return (m_status == eReturnStatusSuccessFinishResult ||
m_status == eReturnStatusSuccessContinuingResult);
}
void CommandReturnObject::Clear() {
lldb::StreamSP stream_sp;
stream_sp = m_out_stream.GetStreamAtIndex(eStreamStringIndex);
if (stream_sp)
static_cast<StreamString *>(stream_sp.get())->Clear();
stream_sp = m_err_stream.GetStreamAtIndex(eStreamStringIndex);
if (stream_sp)
static_cast<StreamString *>(stream_sp.get())->Clear();
m_status = eReturnStatusStarted;
m_did_change_process_state = false;
m_interactive = true;
}
bool CommandReturnObject::GetDidChangeProcessState() {
return m_did_change_process_state;
}
void CommandReturnObject::SetDidChangeProcessState(bool b) {
m_did_change_process_state = b;
}
bool CommandReturnObject::GetInteractive() const { return m_interactive; }
void CommandReturnObject::SetInteractive(bool b) { m_interactive = b; }