[clangd] Replace --project-root with --strong-workspace-mode

Author: Dominicentek

clang-tools-extra/clangd/ClangdServer.cpp

@@ -208,7 +208,7 @@ ClangdServer::Options::operator TUScheduler::Options() const {
   Opts.UpdateDebounce = UpdateDebounce;
   Opts.ContextProvider = ContextProvider;
   Opts.PreambleThrottler = PreambleThrottler;
-  Opts.FallbackProjectRoot = FallbackProjectRoot;
+  Opts.StrongWorkspaceMode = StrongWorkspaceMode;
   return Opts;
 }
 

clang-tools-extra/clangd/ClangdServer.h

@@ -152,9 +152,9 @@ class ClangdServer {
     /// FIXME: If not set, should use the current working directory.
     std::optional<std::string> WorkspaceRoot;
 
-    /// If set, fallback command uses this path as its current working directory
-    /// instead of the file's parent path.
-    std::optional<std::string> FallbackProjectRoot;
+    /// Sets an alterante mode of operation. Current effects are:
+    /// - Using the current working directory as the working directory for fallback commands
+    bool StrongWorkspaceMode;
 
     /// The resource directory is used to find internal headers, overriding
     /// defaults and -resource-dir compiler flag).

clang-tools-extra/clangd/GlobalCompilationDatabase.cpp

@@ -55,7 +55,7 @@ void actOnAllParentDirectories(PathRef FileName,
 } // namespace
 
 tooling::CompileCommand
-GlobalCompilationDatabase::getFallbackCommand(PathRef File, std::optional<std::string> ProjectRoot) const {
+GlobalCompilationDatabase::getFallbackCommand(PathRef File, bool StrongWorkspaceMode) const {
   std::vector<std::string> Argv = {"clang"};
   // Clang treats .h files as C by default and files without extension as linker
   // input, resulting in unhelpful diagnostics.
@@ -64,7 +64,12 @@ GlobalCompilationDatabase::getFallbackCommand(PathRef File, std::optional<std::s
   if (FileExtension.empty() || FileExtension == ".h")
     Argv.push_back("-xobjective-c++-header");
   Argv.push_back(std::string(File));
-  tooling::CompileCommand Cmd(ProjectRoot ? *ProjectRoot : llvm::sys::path::parent_path(File),
+  SmallString<256> WorkingDir;
+  if (StrongWorkspaceMode)
+    llvm::sys::fs::current_path(WorkingDir);
+  else
+    WorkingDir = llvm::sys::path::parent_path(File);
+  tooling::CompileCommand Cmd(WorkingDir,
                               llvm::sys::path::filename(File), std::move(Argv),
                               /*Output=*/"");
   Cmd.Heuristic = "clangd fallback";
@@ -797,8 +802,8 @@ OverlayCDB::getCompileCommand(PathRef File) const {
   return Cmd;
 }
 
-tooling::CompileCommand OverlayCDB::getFallbackCommand(PathRef File, std::optional<std::string> ProjectRoot) const {
-  auto Cmd = DelegatingCDB::getFallbackCommand(File, ProjectRoot);
+tooling::CompileCommand OverlayCDB::getFallbackCommand(PathRef File, bool StrongWorkspaceMode) const {
+  auto Cmd = DelegatingCDB::getFallbackCommand(File, StrongWorkspaceMode);
   std::lock_guard<std::mutex> Lock(Mutex);
   Cmd.CommandLine.insert(Cmd.CommandLine.end(), FallbackFlags.begin(),
                          FallbackFlags.end());
@@ -877,10 +882,10 @@ DelegatingCDB::getProjectModules(PathRef File) const {
   return Base->getProjectModules(File);
 }
 
-tooling::CompileCommand DelegatingCDB::getFallbackCommand(PathRef File, std::optional<std::string> ProjectRoot) const {
+tooling::CompileCommand DelegatingCDB::getFallbackCommand(PathRef File, bool StrongWorkspaceMode) const {
   if (!Base)
-    return GlobalCompilationDatabase::getFallbackCommand(File, ProjectRoot);
-  return Base->getFallbackCommand(File, ProjectRoot);
+    return GlobalCompilationDatabase::getFallbackCommand(File, StrongWorkspaceMode);
+  return Base->getFallbackCommand(File, StrongWorkspaceMode);
 }
 
 bool DelegatingCDB::blockUntilIdle(Deadline D) const {

clang-tools-extra/clangd/GlobalCompilationDatabase.h

@@ -55,7 +55,7 @@ class GlobalCompilationDatabase {
   /// Makes a guess at how to build a file.
   /// The default implementation just runs clang on the file.
   /// Clangd should treat the results as unreliable.
-  virtual tooling::CompileCommand getFallbackCommand(PathRef File, std::optional<std::string> ProjectRoot = std::nullopt) const;
+  virtual tooling::CompileCommand getFallbackCommand(PathRef File, bool StrongWorkspaceMode = false) const;
 
   /// If the CDB does any asynchronous work, wait for it to complete.
   /// For use in tests.
@@ -86,7 +86,7 @@ class DelegatingCDB : public GlobalCompilationDatabase {
   std::unique_ptr<ProjectModules>
   getProjectModules(PathRef File) const override;
 
-  tooling::CompileCommand getFallbackCommand(PathRef File, std::optional<std::string> ProjectRoot = std::nullopt) const override;
+  tooling::CompileCommand getFallbackCommand(PathRef File, bool StrongWorkspaceMode = false) const override;
 
   bool blockUntilIdle(Deadline D) const override;
 
@@ -200,7 +200,7 @@ class OverlayCDB : public DelegatingCDB {
 
   std::optional<tooling::CompileCommand>
   getCompileCommand(PathRef File) const override;
-  tooling::CompileCommand getFallbackCommand(PathRef File, std::optional<std::string> ProjectRoot = std::nullopt) const override;
+  tooling::CompileCommand getFallbackCommand(PathRef File, bool StrongWorkspaceMode = false) const override;
 
   /// Sets or clears the compilation command for a particular file.
   /// Returns true if the command was changed (including insertion and removal),

clang-tools-extra/clangd/TUScheduler.cpp

@@ -723,7 +723,7 @@ class ASTWorker {
   const GlobalCompilationDatabase &CDB;
   /// Callback invoked when preamble or main file AST is built.
   ParsingCallbacks &Callbacks;
-  std::optional<std::string> FallbackProjectRoot;
+  bool StrongWorkspaceMode;
 
   Semaphore &Barrier;
   /// Whether the 'onMainAST' callback ran for the current FileInputs.
@@ -841,14 +841,14 @@ ASTWorker::ASTWorker(PathRef FileName, const GlobalCompilationDatabase &CDB,
     : IdleASTs(LRUCache), HeaderIncluders(HeaderIncluders), RunSync(RunSync),
       UpdateDebounce(Opts.UpdateDebounce), FileName(FileName),
       ContextProvider(Opts.ContextProvider), CDB(CDB), Callbacks(Callbacks),
-      FallbackProjectRoot(Opts.FallbackProjectRoot),
+      StrongWorkspaceMode(Opts.StrongWorkspaceMode),
       Barrier(Barrier), Done(false), Status(FileName, Callbacks),
       PreamblePeer(FileName, Callbacks, Opts.StorePreamblesInMemory, RunSync,
                    Opts.PreambleThrottler, Status, HeaderIncluders, *this) {
   // Set a fallback command because compile command can be accessed before
   // `Inputs` is initialized. Other fields are only used after initialization
   // from client inputs.
-  FileInputs.CompileCommand = CDB.getFallbackCommand(FileName, FallbackProjectRoot);
+  FileInputs.CompileCommand = CDB.getFallbackCommand(FileName, StrongWorkspaceMode);
 }
 
 ASTWorker::~ASTWorker() {
@@ -890,7 +890,7 @@ void ASTWorker::update(ParseInputs Inputs, WantDiagnostics WantDiags,
     if (Cmd)
       Inputs.CompileCommand = std::move(*Cmd);
     else
-      Inputs.CompileCommand = CDB.getFallbackCommand(FileName, FallbackProjectRoot);
+      Inputs.CompileCommand = CDB.getFallbackCommand(FileName, StrongWorkspaceMode);
 
     bool InputsAreTheSame =
         std::tie(FileInputs.CompileCommand, FileInputs.Contents) ==

clang-tools-extra/clangd/TUScheduler.h

@@ -237,9 +237,8 @@ class TUScheduler {
     /// If the path is empty, context sholud be "generic".
     std::function<Context(PathRef)> ContextProvider;
 
-    /// If set, fallback command uses this path as its current working directory
-    /// instead of the file's parent path.
-    std::optional<std::string> FallbackProjectRoot;
+    /// Sets an alterante mode of operation. See ClangdServer::Options::StrongWorkspaceMode.
+    bool StrongWorkspaceMode;
   };
 
   TUScheduler(const GlobalCompilationDatabase &CDB, const Options &Opts,

clang-tools-extra/clangd/tool/Check.cpp

@@ -187,7 +187,7 @@ class Checker {
           Cmd.Heuristic.empty() ? "from CDB" : Cmd.Heuristic, Cmd.Directory,
           printArgv(Cmd.CommandLine));
     } else {
-      Cmd = CDB->getFallbackCommand(File, Opts.FallbackProjectRoot);
+      Cmd = CDB->getFallbackCommand(File, Opts.StrongWorkspaceMode);
       log("Generic fallback command is: [{0}] {1}", Cmd.Directory,
           printArgv(Cmd.CommandLine));
     }

clang-tools-extra/clangd/tool/ClangdMain.cpp

@@ -500,12 +500,13 @@ opt<bool> EnableConfig{
     init(true),
 };
 
-opt<Path> ProjectRoot{
-    "project-root",
-    cat(Misc),
-    desc("Path to use as the current working directory for fallback commands."),
-    init(""),
-    ValueOptional,
+opt<bool> StrongWorkspaceMode{
+    "strong-workspace-mode",
+    cat(Features),
+    desc(
+        "An alternate mode of operation for clangd, operating more closely to the workspace.\n"
+        "When enabled, fallback commands use the workspace directory as their working directory instead of the parent folder."),
+    init(false),
 };
 
 opt<bool> UseDirtyHeaders{"use-dirty-headers", cat(Misc),
@@ -915,8 +916,7 @@ clangd accepts flags on the commandline, and in the CLANGD_FLAGS environment var
   }
   if (!ResourceDir.empty())
     Opts.ResourceDir = ResourceDir;
-  if (!ProjectRoot.empty())
-    Opts.FallbackProjectRoot = ProjectRoot;
+  Opts.StrongWorkspaceMode = StrongWorkspaceMode;
   Opts.BuildDynamicSymbolIndex = true;
 #if CLANGD_ENABLE_REMOTE
   if (RemoteIndexAddress.empty() != ProjectRoot.empty()) {