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, 63 insertions, 70 deletions

diff --git a/lldb/source/Plugins/Platform/MacOSX/PlatformDarwin.cpp b/lldb/source/Plugins/Platform/MacOSX/PlatformDarwin.cpp
index 8e031680214..e6ed57ac716 100644
--- a/lldb/source/Plugins/Platform/MacOSX/PlatformDarwin.cpp
+++ b/lldb/source/Plugins/Platform/MacOSX/PlatformDarwin.cpp
@@ -73,10 +73,9 @@ FileSpecList PlatformDarwin::LocateExecutableScriptingResources(
     // NB some extensions might be meaningful and should not be stripped -
     // "this.binary.file"
     // should not lose ".file" but GetFileNameStrippingExtension() will do
-    // precisely that.
-    // Ideally, we should have a per-platform list of extensions (".exe",
-    // ".app", ".dSYM", ".framework")
-    // which should be stripped while leaving "this.binary.file" as-is.
+    // precisely that. Ideally, we should have a per-platform list of
+    // extensions (".exe", ".app", ".dSYM", ".framework") which should be
+    // stripped while leaving "this.binary.file" as-is.
     ScriptInterpreter *script_interpreter =
         target->GetDebugger().GetCommandInterpreter().GetScriptInterpreter();
 
@@ -101,14 +100,11 @@ FileSpecList PlatformDarwin::LocateExecutableScriptingResources(
                 // FIXME: for Python, we cannot allow certain characters in
                 // module
                 // filenames we import. Theoretically, different scripting
-                // languages may
-                // have different sets of forbidden tokens in filenames, and
-                // that should
-                // be dealt with by each ScriptInterpreter. For now, we just
-                // replace dots
-                // with underscores, but if we ever support anything other than
-                // Python
-                // we will need to rework this
+                // languages may have different sets of forbidden tokens in
+                // filenames, and that should be dealt with by each
+                // ScriptInterpreter. For now, we just replace dots with
+                // underscores, but if we ever support anything other than
+                // Python we will need to rework this
                 std::replace(module_basename.begin(), module_basename.end(),
                              '.', '_');
                 std::replace(module_basename.begin(), module_basename.end(),
@@ -125,9 +121,9 @@ FileSpecList PlatformDarwin::LocateExecutableScriptingResources(
                 StreamString path_string;
                 StreamString original_path_string;
                 // for OSX we are going to be in
-                // .dSYM/Contents/Resources/DWARF/<basename>
-                // let us go to .dSYM/Contents/Resources/Python/<basename>.py
-                // and see if the file exists
+                // .dSYM/Contents/Resources/DWARF/<basename> let us go to
+                // .dSYM/Contents/Resources/Python/<basename>.py and see if the
+                // file exists
                 path_string.Printf("%s/../Python/%s.py",
                                    symfile_spec.GetDirectory().GetCString(),
                                    module_basename.c_str());
@@ -140,9 +136,8 @@ FileSpecList PlatformDarwin::LocateExecutableScriptingResources(
                                            true);
 
                 // if we did some replacements of reserved characters, and a
-                // file with the untampered name
-                // exists, then warn the user that the file as-is shall not be
-                // loaded
+                // file with the untampered name exists, then warn the user
+                // that the file as-is shall not be loaded
                 if (feedback_stream) {
                   if (module_basename != original_module_basename &&
                       orig_script_fspec.Exists()) {
@@ -178,8 +173,8 @@ FileSpecList PlatformDarwin::LocateExecutableScriptingResources(
                   break;
                 }
 
-                // If we didn't find the python file, then keep
-                // stripping the extensions and try again
+                // If we didn't find the python file, then keep stripping the
+                // extensions and try again
                 ConstString filename_no_extension(
                     module_spec.GetFileNameStrippingExtension());
                 if (module_spec.GetFilename() == filename_no_extension)
@@ -270,8 +265,8 @@ lldb_private::Status PlatformDarwin::GetSharedModuleWithLocalCache(
       FileSpec module_cache_spec(cache_path, false);
 
       // if rsync is supported, always bring in the file - rsync will be very
-      // efficient
-      // when files are the same on the local and remote end of the connection
+      // efficient when files are the same on the local and remote end of the
+      // connection
       if (this->GetSupportsRSync()) {
         err = BringInRemoteFile(this, module_spec, module_cache_spec);
         if (err.Fail())
@@ -370,8 +365,8 @@ Status PlatformDarwin::GetSharedModule(
   module_sp.reset();
 
   if (IsRemote()) {
-    // If we have a remote platform always, let it try and locate
-    // the shared module first.
+    // If we have a remote platform always, let it try and locate the shared
+    // module first.
     if (m_remote_platform_sp) {
       error = m_remote_platform_sp->GetSharedModule(
           module_spec, process, module_sp, module_search_paths_ptr,
@@ -453,8 +448,8 @@ PlatformDarwin::GetSoftwareBreakpointTrapOpcode(Target &target,
   switch (machine) {
   case llvm::Triple::aarch64: {
     // TODO: fix this with actual darwin breakpoint opcode for arm64.
-    // right now debugging uses the Z packets with GDB remote so this
-    // is not needed, but the size needs to be correct...
+    // right now debugging uses the Z packets with GDB remote so this is not
+    // needed, but the size needs to be correct...
     static const uint8_t g_arm64_breakpoint_opcode[] = {0xFE, 0xDE, 0xFF, 0xE7};
     trap_opcode = g_arm64_breakpoint_opcode;
     trap_opcode_size = sizeof(g_arm64_breakpoint_opcode);
@@ -548,8 +543,8 @@ bool PlatformDarwin::x86GetSupportedArchitectureAtIndex(uint32_t idx,
           HostInfo::GetArchitecture(HostInfo::eArchKind64));
       if (platform_arch.IsExactMatch(platform_arch64)) {
         // This macosx platform supports both 32 and 64 bit. Since we already
-        // returned the 64 bit arch for idx == 0, return the 32 bit arch
-        // for idx == 1
+        // returned the 64 bit arch for idx == 0, return the 32 bit arch for
+        // idx == 1
         arch = HostInfo::GetArchitecture(HostInfo::eArchKind32);
         return arch.IsValid();
       }
@@ -558,9 +553,9 @@ bool PlatformDarwin::x86GetSupportedArchitectureAtIndex(uint32_t idx,
   return false;
 }
 
-// The architecture selection rules for arm processors
-// These cpu subtypes have distinct names (e.g. armv7f) but armv7 binaries run
-// fine on an armv7f processor.
+// The architecture selection rules for arm processors These cpu subtypes have
+// distinct names (e.g. armv7f) but armv7 binaries run fine on an armv7f
+// processor.
 
 bool PlatformDarwin::ARMGetSupportedArchitectureAtIndex(uint32_t idx,
                                                         ArchSpec &arch) {
@@ -1145,7 +1140,8 @@ const char *PlatformDarwin::GetDeveloperDirectory() {
     if (HostInfo::GetLLDBPath(ePathTypeLLDBShlibDir, temp_file_spec)) {
       if (temp_file_spec.GetPath(developer_dir_path,
                                  sizeof(developer_dir_path))) {
-        // e.g. /Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework
+        // e.g.
+        // /Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework
         char *shared_frameworks =
             strstr(developer_dir_path, "/SharedFrameworks/LLDB.framework");
         if (shared_frameworks) {
@@ -1153,7 +1149,8 @@ const char *PlatformDarwin::GetDeveloperDirectory() {
           strncat (developer_dir_path, "/Developer", sizeof (developer_dir_path) - 1); // add /Developer on
           developer_dir_path_valid = true;
         } else {
-          // e.g. /Applications/Xcode.app/Contents/Developer/Toolchains/iOS11.2.xctoolchain/System/Library/PrivateFrameworks/LLDB.framework
+          // e.g.
+          // /Applications/Xcode.app/Contents/Developer/Toolchains/iOS11.2.xctoolchain/System/Library/PrivateFrameworks/LLDB.framework
           char *developer_toolchains =
             strstr(developer_dir_path, "/Contents/Developer/Toolchains/");
           if (developer_toolchains) {
@@ -1230,8 +1227,8 @@ const char *PlatformDarwin::GetDeveloperDirectory() {
     m_developer_directory.assign(1, '\0');
   }
 
-  // We should have put a single NULL character into m_developer_directory
-  // or it should have a valid path if the code gets here
+  // We should have put a single NULL character into m_developer_directory or
+  // it should have a valid path if the code gets here
   assert(m_developer_directory.empty() == false);
   if (m_developer_directory[0])
     return m_developer_directory.c_str();
@@ -1279,9 +1276,9 @@ PlatformDarwin::GetResumeCountForLaunchInfo(ProcessLaunchInfo &launch_info) {
     shell_name++;
 
   if (strcmp(shell_name, "sh") == 0) {
-    // /bin/sh re-exec's itself as /bin/bash requiring another resume.
-    // But it only does this if the COMMAND_MODE environment variable
-    // is set to "legacy".
+    // /bin/sh re-exec's itself as /bin/bash requiring another resume. But it
+    // only does this if the COMMAND_MODE environment variable is set to
+    // "legacy".
     if (launch_info.GetEnvironment().lookup("COMMAND_MODE") == "legacy")
       return 2;
     return 1;
@@ -1333,9 +1330,8 @@ static FileSpec GetXcodeContentsPath() {
 
     // First get the program file spec. If lldb.so or LLDB.framework is running
     // in a program and that program is Xcode, the path returned with be the
-    // path
-    // to Xcode.app/Contents/MacOS/Xcode, so this will be the correct Xcode to
-    // use.
+    // path to Xcode.app/Contents/MacOS/Xcode, so this will be the correct
+    // Xcode to use.
     fspec = HostInfo::GetProgramFileSpec();
 
     if (fspec) {
@@ -1679,10 +1675,8 @@ bool PlatformDarwin::GetOSVersion(uint32_t &major, uint32_t &minor,
       }
     }
     // For simulator platforms, do NOT call back through
-    // Platform::GetOSVersion()
-    // as it might call Process::GetHostOSVersion() which we don't want as it
-    // will be
-    // incorrect
+    // Platform::GetOSVersion() as it might call Process::GetHostOSVersion()
+    // which we don't want as it will be incorrect
     return false;
   }
 
@@ -1695,8 +1689,8 @@ lldb_private::FileSpec PlatformDarwin::LocateExecutable(const char *basename) {
   // any executable directories that should be searched.
   static std::vector<FileSpec> g_executable_dirs;
 
-  // Find the global list of directories that we will search for
-  // executables once so we don't keep doing the work over and over.
+  // Find the global list of directories that we will search for executables
+  // once so we don't keep doing the work over and over.
   static llvm::once_flag g_once_flag;
   llvm::call_once(g_once_flag, []() {
 
@@ -1730,19 +1724,18 @@ lldb_private::FileSpec PlatformDarwin::LocateExecutable(const char *basename) {
 
 lldb_private::Status
 PlatformDarwin::LaunchProcess(lldb_private::ProcessLaunchInfo &launch_info) {
-  // Starting in Fall 2016 OSes, NSLog messages only get mirrored to stderr
-  // if the OS_ACTIVITY_DT_MODE environment variable is set.  (It doesn't
-  // require any specific value; rather, it just needs to exist).
-  // We will set it here as long as the IDE_DISABLED_OS_ACTIVITY_DT_MODE flag
-  // is not set.  Xcode makes use of IDE_DISABLED_OS_ACTIVITY_DT_MODE to tell
+  // Starting in Fall 2016 OSes, NSLog messages only get mirrored to stderr if
+  // the OS_ACTIVITY_DT_MODE environment variable is set.  (It doesn't require
+  // any specific value; rather, it just needs to exist). We will set it here
+  // as long as the IDE_DISABLED_OS_ACTIVITY_DT_MODE flag is not set.  Xcode
+  // makes use of IDE_DISABLED_OS_ACTIVITY_DT_MODE to tell
   // LLDB *not* to muck with the OS_ACTIVITY_DT_MODE flag when they
   // specifically want it unset.
   const char *disable_env_var = "IDE_DISABLED_OS_ACTIVITY_DT_MODE";
   auto &env_vars = launch_info.GetEnvironment();
   if (!env_vars.count(disable_env_var)) {
-    // We want to make sure that OS_ACTIVITY_DT_MODE is set so that
-    // we get os_log and NSLog messages mirrored to the target process
-    // stderr.
+    // We want to make sure that OS_ACTIVITY_DT_MODE is set so that we get
+    // os_log and NSLog messages mirrored to the target process stderr.
     env_vars.try_emplace("OS_ACTIVITY_DT_MODE", "enable");
   }
 
@@ -1757,15 +1750,16 @@ PlatformDarwin::FindBundleBinaryInExecSearchPaths (const ModuleSpec &module_spec
                                                    ModuleSP *old_module_sp_ptr, bool *did_create_ptr)
 {
   const FileSpec &platform_file = module_spec.GetFileSpec();
-  // See if the file is present in any of the module_search_paths_ptr directories.
+  // See if the file is present in any of the module_search_paths_ptr
+  // directories.
   if (!module_sp && module_search_paths_ptr && platform_file) {
-    // create a vector of all the file / directory names in platform_file
-    // e.g. this might be
+    // create a vector of all the file / directory names in platform_file e.g.
+    // this might be
     // /System/Library/PrivateFrameworks/UIFoundation.framework/UIFoundation
     //
-    // We'll need to look in the module_search_paths_ptr directories for
-    // both "UIFoundation" and "UIFoundation.framework" -- most likely the
-    // latter will be the one we find there.
+    // We'll need to look in the module_search_paths_ptr directories for both
+    // "UIFoundation" and "UIFoundation.framework" -- most likely the latter
+    // will be the one we find there.
 
     FileSpec platform_pull_apart(platform_file);
     std::vector<std::string> path_parts;
@@ -1784,25 +1778,24 @@ PlatformDarwin::FindBundleBinaryInExecSearchPaths (const ModuleSpec &module_spec
       Log *log_verbose = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
       if (log_verbose)
           log_verbose->Printf ("PlatformRemoteDarwinDevice::GetSharedModule searching for binary in search-path %s", module_search_paths_ptr->GetFileSpecAtIndex(i).GetPath().c_str());
-      // Create a new FileSpec with this module_search_paths_ptr
-      // plus just the filename ("UIFoundation"), then the parent
-      // dir plus filename ("UIFoundation.framework/UIFoundation")
-      // etc - up to four names (to handle "Foo.framework/Contents/MacOS/Foo")
+      // Create a new FileSpec with this module_search_paths_ptr plus just the
+      // filename ("UIFoundation"), then the parent dir plus filename
+      // ("UIFoundation.framework/UIFoundation") etc - up to four names (to
+      // handle "Foo.framework/Contents/MacOS/Foo")
 
       for (size_t j = 0; j < 4 && j < path_parts_size - 1; ++j) {
         FileSpec path_to_try(module_search_paths_ptr->GetFileSpecAtIndex(i));
 
         // Add the components backwards.  For
-        // .../PrivateFrameworks/UIFoundation.framework/UIFoundation
-        // path_parts is
+        // .../PrivateFrameworks/UIFoundation.framework/UIFoundation path_parts
+        // is
         //   [0] UIFoundation
         //   [1] UIFoundation.framework
         //   [2] PrivateFrameworks
         //
         // and if 'j' is 2, we want to append path_parts[1] and then
-        // path_parts[0], aka
-        // 'UIFoundation.framework/UIFoundation', to the module_search_paths_ptr
-        // path.
+        // path_parts[0], aka 'UIFoundation.framework/UIFoundation', to the
+        // module_search_paths_ptr path.
 
         for (int k = j; k >= 0; --k) {
           path_to_try.AppendPathComponent(path_parts[k]);