Adding some documentation to lldb_dap::Log and moving the impl out of the header.

Author: ashgti

lldb/tools/lldb-dap/CMakeLists.txt

@@ -23,6 +23,7 @@ add_lldb_tool(lldb-dap
   Breakpoint.cpp
   BreakpointBase.cpp
   DAP.cpp
+  DAPLog.cpp
   EventHelper.cpp
   ExceptionBreakpoint.cpp
   FifoFiles.cpp

lldb/tools/lldb-dap/DAP.cpp

@@ -68,8 +68,7 @@ const char DEV_NULL[] = "/dev/null";
 
 namespace lldb_dap {
 
-DAP::DAP(llvm::StringRef path, Log *log,
-         const ReplMode default_repl_mode,
+DAP::DAP(llvm::StringRef path, Log *log, const ReplMode default_repl_mode,
          std::vector<std::string> pre_init_commands, Transport &transport)
     : debug_adapter_path(path), log(log), transport(transport),
       broadcaster("lldb-dap"), exception_breakpoints(),

lldb/tools/lldb-dap/DAP.h

@@ -218,8 +218,7 @@ struct DAP {
   ///     LLDB commands to execute as soon as the debugger instance is allocaed.
   /// \param[in] transport
   ///     Transport for this debug session.
-  DAP(llvm::StringRef path, Log *log,
-      const ReplMode default_repl_mode,
+  DAP(llvm::StringRef path, Log *log, const ReplMode default_repl_mode,
       std::vector<std::string> pre_init_commands, Transport &transport);
 
   ~DAP();

lldb/tools/lldb-dap/DAPLog.cpp

@@ -0,0 +1,26 @@
+//===-- DAPLog.cpp --------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "DAPLog.h"
+#include "llvm/ADT/StringRef.h"
+#include <fstream>
+#include <mutex>
+
+using namespace llvm;
+
+namespace lldb_dap {
+
+Log::Log(StringRef filename) : m_stream(std::ofstream(filename.str())) {}
+
+void Log::WriteMessage(StringRef message) {
+  std::scoped_lock<std::mutex> lock(m_mutex);
+  m_stream << message.str();
+  m_stream.flush();
+}
+
+} // namespace lldb_dap

lldb/tools/lldb-dap/DAPLog.h

@@ -54,15 +54,20 @@
 
 namespace lldb_dap {
 
-class Log {
+/// Log manages the lldb-dap log file, used with the corresponding `DAP_LOG` and
+/// `DAP_LOG_ERROR` helpers.
+class Log final {
 public:
-  Log(std::ofstream stream) : m_stream(std::move(stream)) {}
+  /// Creates a log file with the given filename.
+  Log(llvm::StringRef filename);
 
-  void WriteMessage(llvm::StringRef message) {
-    std::scoped_lock<std::mutex> lock(m_mutex);
-    m_stream << message.str();
-    m_stream.flush();
-  }
+  /// Log is not copyable.
+  /// @{
+  Log(const Log &) = delete;
+  void operator=(const Log &) = delete;
+  /// @}
+
+  void WriteMessage(llvm::StringRef message);
 
 private:
   std::mutex m_mutex;

lldb/tools/lldb-dap/Transport.cpp

@@ -63,8 +63,8 @@ static constexpr StringLiteral kHeaderSeparator = "\r\n\r\n";
 
 namespace lldb_dap {
 
-Transport::Transport(StringRef client_name, Log *log,
-                     IOObjectSP input, IOObjectSP output)
+Transport::Transport(StringRef client_name, Log *log, IOObjectSP input,
+                     IOObjectSP output)
     : m_client_name(client_name), m_log(log), m_input(std::move(input)),
       m_output(std::move(output)) {}
 

lldb/tools/lldb-dap/lldb-dap.cpp

@@ -487,7 +487,7 @@ int main(int argc, char *argv[]) {
   std::unique_ptr<Log> log = nullptr;
   const char *log_file_path = getenv("LLDBDAP_LOG");
   if (log_file_path)
-    log = std::make_unique<Log>(std::ofstream(log_file_path));
+    log = std::make_unique<Log>(log_file_path);
 
   // Initialize LLDB first before we do anything.
   lldb::SBError error = lldb::SBDebugger::InitializeWithErrorHandling();