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

1 files changed, 45 insertions, 48 deletions

diff --git a/lldb/source/Core/Debugger.cpp b/lldb/source/Core/Debugger.cpp
index 824b2afaa44..3ade4d1db6a 100644
--- a/lldb/source/Core/Debugger.cpp
+++ b/lldb/source/Core/Debugger.cpp
@@ -167,13 +167,15 @@ OptionEnumValueElement g_language_enumerators[] = {
   "}${addr-file-or-load}{ "                                                    \
   "<${function.concrete-only-addr-offset-no-padding}>}: "
 
-// gdb's disassembly format can be emulated with
-// ${current-pc-arrow}${addr-file-or-load}{
-// <${function.name-without-args}${function.concrete-only-addr-offset-no-padding}>}:
+// gdb's disassembly format can be emulated with ${current-pc-arrow}${addr-
+// file-or-load}{ <${function.name-without-args}${function.concrete-only-addr-
+// offset-no-padding}>}:
 
 // lldb's original format for disassembly would look like this format string -
-// {${function.initial-function}{${module.file.basename}`}{${function.name-without-args}}:\n}{${function.changed}\n{${module.file.basename}`}{${function.name-without-args}}:\n}{${current-pc-arrow}
-// }{${addr-file-or-load}}:
+// {${function.initial-function}{${module.file.basename}`}{${function.name-
+// without-
+// args}}:\n}{${function.changed}\n{${module.file.basename}`}{${function.name-
+// without-args}}:\n}{${current-pc-arrow} }{${addr-file-or-load}}:
 
 #define DEFAULT_STOP_SHOW_COLUMN_ANSI_PREFIX "${ansi.underline}"
 #define DEFAULT_STOP_SHOW_COLUMN_ANSI_SUFFIX "${ansi.normal}"
@@ -590,9 +592,9 @@ bool Debugger::LoadPlugin(const FileSpec &spec, Status &error) {
       return true;
     }
   } else {
-    // The g_load_plugin_callback is registered in SBDebugger::Initialize()
-    // and if the public API layer isn't available (code is linking against
-    // all of the internal LLDB static libraries), then we can't load plugins
+    // The g_load_plugin_callback is registered in SBDebugger::Initialize() and
+    // if the public API layer isn't available (code is linking against all of
+    // the internal LLDB static libraries), then we can't load plugins
     error.SetErrorString("Public API layer is not available");
   }
   return false;
@@ -612,8 +614,8 @@ LoadPluginCallback(void *baton, llvm::sys::fs::file_type ft,
   Debugger *debugger = (Debugger *)baton;
 
   namespace fs = llvm::sys::fs;
-  // If we have a regular file, a symbolic link or unknown file type, try
-  // and process the file. We must handle unknown as sometimes the directory
+  // If we have a regular file, a symbolic link or unknown file type, try and
+  // process the file. We must handle unknown as sometimes the directory
   // enumeration might be enumerating a file system that doesn't have correct
   // file type information.
   if (ft == fs::file_type::regular_file || ft == fs::file_type::symlink_file ||
@@ -633,9 +635,9 @@ LoadPluginCallback(void *baton, llvm::sys::fs::file_type ft,
   } else if (ft == fs::file_type::directory_file ||
              ft == fs::file_type::symlink_file ||
              ft == fs::file_type::type_unknown) {
-    // Try and recurse into anything that a directory or symbolic link.
-    // We must also do this for unknown as sometimes the directory enumeration
-    // might be enumerating a file system that doesn't have correct file type
+    // Try and recurse into anything that a directory or symbolic link. We must
+    // also do this for unknown as sometimes the directory enumeration might be
+    // enumerating a file system that doesn't have correct file type
     // information.
     return FileSpec::eEnumerateDirectoryResultEnter;
   }
@@ -800,10 +802,9 @@ Debugger::~Debugger() { Clear(); }
 
 void Debugger::Clear() {
   //----------------------------------------------------------------------
-  // Make sure we call this function only once. With the C++ global
-  // destructor chain having a list of debuggers and with code that can be
-  // running on other threads, we need to ensure this doesn't happen
-  // multiple times.
+  // Make sure we call this function only once. With the C++ global destructor
+  // chain having a list of debuggers and with code that can be running on
+  // other threads, we need to ensure this doesn't happen multiple times.
   //
   // The following functions call Debugger::Clear():
   //     Debugger::~Debugger();
@@ -828,8 +829,7 @@ void Debugger::Clear() {
     m_broadcaster_manager_sp->Clear();
 
     // Close the input file _before_ we close the input read communications
-    // class
-    // as it does NOT own the input file, our m_input_file does.
+    // class as it does NOT own the input file, our m_input_file does.
     m_terminal_state.Clear();
     if (m_input_file_sp)
       m_input_file_sp->GetFile().Close();
@@ -865,8 +865,8 @@ void Debugger::SetInputFileHandle(FILE *fh, bool tranfer_ownership) {
   if (!in_file.IsValid())
     in_file.SetStream(stdin, true);
 
-  // Save away the terminal state if that is relevant, so that we can restore it
-  // in RestoreInputState.
+  // Save away the terminal state if that is relevant, so that we can restore
+  // it in RestoreInputState.
   SaveInputTerminalState();
 }
 
@@ -880,8 +880,8 @@ void Debugger::SetOutputFileHandle(FILE *fh, bool tranfer_ownership) {
   if (!out_file.IsValid())
     out_file.SetStream(stdout, false);
 
-  // do not create the ScriptInterpreter just for setting the output file handle
-  // as the constructor will know how to do the right thing on its own
+  // do not create the ScriptInterpreter just for setting the output file
+  // handle as the constructor will know how to do the right thing on its own
   const bool can_create = false;
   ScriptInterpreter *script_interpreter =
       GetCommandInterpreter().GetScriptInterpreter(can_create);
@@ -1027,11 +1027,10 @@ void Debugger::RunIOHandler(const IOHandlerSP &reader_sp) {
 void Debugger::AdoptTopIOHandlerFilesIfInvalid(StreamFileSP &in,
                                                StreamFileSP &out,
                                                StreamFileSP &err) {
-  // Before an IOHandler runs, it must have in/out/err streams.
-  // This function is called when one ore more of the streams
-  // are nullptr. We use the top input reader's in/out/err streams,
-  // or fall back to the debugger file handles, or we fall back
-  // onto stdin/stdout/stderr as a last resort.
+  // Before an IOHandler runs, it must have in/out/err streams. This function
+  // is called when one ore more of the streams are nullptr. We use the top
+  // input reader's in/out/err streams, or fall back to the debugger file
+  // handles, or we fall back onto stdin/stdout/stderr as a last resort.
 
   std::lock_guard<std::recursive_mutex> guard(m_input_reader_stack.GetMutex());
   IOHandlerSP top_reader_sp(m_input_reader_stack.Top());
@@ -1087,8 +1086,8 @@ void Debugger::PushIOHandler(const IOHandlerSP &reader_sp) {
   m_input_reader_stack.Push(reader_sp);
   reader_sp->Activate();
 
-  // Interrupt the top input reader to it will exit its Run() function
-  // and let this new input reader take over
+  // Interrupt the top input reader to it will exit its Run() function and let
+  // this new input reader take over
   if (top_reader_sp) {
     top_reader_sp->Deactivate();
     top_reader_sp->Cancel();
@@ -1101,8 +1100,8 @@ bool Debugger::PopIOHandler(const IOHandlerSP &pop_reader_sp) {
 
   std::lock_guard<std::recursive_mutex> guard(m_input_reader_stack.GetMutex());
 
-  // The reader on the stop of the stack is done, so let the next
-  // read on the stack refresh its prompt and if there is one...
+  // The reader on the stop of the stack is done, so let the next read on the
+  // stack refresh its prompt and if there is one...
   if (m_input_reader_stack.IsEmpty())
     return false;
 
@@ -1197,8 +1196,8 @@ bool Debugger::FormatDisassemblerAddress(const FormatEntity::Entry *format,
       }
     }
   }
-  // The first context on a list of instructions will have a prev_sc that
-  // has no Function or Symbol -- if SymbolContext had an IsValid() method, it
+  // The first context on a list of instructions will have a prev_sc that has
+  // no Function or Symbol -- if SymbolContext had an IsValid() method, it
   // would return false.  But we do get a prev_sc pointer.
   if ((sc && (sc->function || sc->symbol)) && prev_sc &&
       (prev_sc->function == nullptr && prev_sc->symbol == nullptr)) {
@@ -1464,8 +1463,8 @@ void Debugger::HandleProcessEvent(const EventSP &event_sp) {
 }
 
 void Debugger::HandleThreadEvent(const EventSP &event_sp) {
-  // At present the only thread event we handle is the Frame Changed event,
-  // and all we do for that is just reprint the thread status for that thread.
+  // At present the only thread event we handle is the Frame Changed event, and
+  // all we do for that is just reprint the thread status for that thread.
   using namespace lldb;
   const uint32_t event_type = event_sp->GetType();
   const bool stop_format = true;
@@ -1518,8 +1517,8 @@ void Debugger::DefaultEventHandler() {
           CommandInterpreter::eBroadcastBitAsynchronousOutputData |
           CommandInterpreter::eBroadcastBitAsynchronousErrorData);
 
-  // Let the thread that spawned us know that we have started up and
-  // that we are now listening to all required events so no events get missed
+  // Let the thread that spawned us know that we have started up and that we
+  // are now listening to all required events so no events get missed
   m_sync_broadcaster.BroadcastEvent(eBroadcastBitEventThreadIsListening);
 
   bool done = false;
@@ -1584,9 +1583,9 @@ lldb::thread_result_t Debugger::EventHandlerThread(lldb::thread_arg_t arg) {
 
 bool Debugger::StartEventHandlerThread() {
   if (!m_event_handler_thread.IsJoinable()) {
-    // We must synchronize with the DefaultEventHandler() thread to ensure
-    // it is up and running and listening to events before we return from
-    // this function. We do this by listening to events for the
+    // We must synchronize with the DefaultEventHandler() thread to ensure it
+    // is up and running and listening to events before we return from this
+    // function. We do this by listening to events for the
     // eBroadcastBitEventThreadIsListening from the m_sync_broadcaster
     ListenerSP listener_sp(
         Listener::MakeListener("lldb.debugger.event-handler"));
@@ -1598,13 +1597,11 @@ bool Debugger::StartEventHandlerThread() {
         "lldb.debugger.event-handler", EventHandlerThread, this, nullptr,
         g_debugger_event_thread_stack_bytes);
 
-    // Make sure DefaultEventHandler() is running and listening to events before
-    // we return
-    // from this function. We are only listening for events of type
-    // eBroadcastBitEventThreadIsListening so we don't need to check the event,
-    // we just need
-    // to wait an infinite amount of time for it (nullptr timeout as the first
-    // parameter)
+    // Make sure DefaultEventHandler() is running and listening to events
+    // before we return from this function. We are only listening for events of
+    // type eBroadcastBitEventThreadIsListening so we don't need to check the
+    // event, we just need to wait an infinite amount of time for it (nullptr
+    // timeout as the first parameter)
     lldb::EventSP event_sp;
     listener_sp->GetEvent(event_sp, llvm::None);
   }