[clangd] Remove --inlay-hints flag

[kadircet]

nit: I'd rename the patch to remove rather than retire.

[sammccall]

rename patch

[sammccall]

In D117036#3234786, @kadircet wrote:

nit: I'd rename the patch to remove rather than retire.

Done.

[kadircet]

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

296

oops, missed this one in the previous revision.

any reason for not directly dropping it? this was an "experimental flag" which we didn't advertise publicly (until one or two weeks ago, and even then we don't mention the flag, https://clangd.llvm.org/extensions#inlay-hints)

[sammccall]

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

296

It leaked!

https://chromium.googlesource.com/chromiumos/docs/+/main/chroot-clangd-guide.md
https://stackoverflow.com/a/69656325/1556111

[kadircet]

thanks, as discussed offline, i was mostly worried about the user confusion we would get when people can't turn it off with --inlay-hints=false but this has both made it into clangd-13 and has been mentioned by others in public enough places, so rather than breaking people with next release let's keep it.

clang-tools-extra/clangd/ClangdLSPServer.h

struct Options : ClangdServer::Options {
     clangd::CodeCompleteOptions CodeComplete;
     MarkupKind SignatureHelpDocumentationFormat = MarkupKind::PlainText;
     clangd::RenameOptions Rename;
     /// Returns true if the tweak should be enabled.
     std::function<bool(const Tweak &)> TweakFilter = [](const Tweak &T) {
       return !T.hidden(); // only enable non-hidden tweaks.
     };
 
-    /// Enable InlayHints feature.
-    bool InlayHints = true;
-
     /// Limit the number of references returned (0 means no limit).
     size_t ReferencesLimit = 0;
   };
 
   ClangdLSPServer(Transport &Transp, const ThreadsafeFS &TFS,
                   const ClangdLSPServer::Options &Opts);
   /// The destructor blocks on any outstanding background tasks.
   ~ClangdLSPServer();

clang-tools-extra/clangd/ClangdLSPServer.cpp

llvm::json::Object ServerCaps{
       {"workspaceSymbolProvider", true},
       {"referencesProvider", true},
       {"astProvider", true}, // clangd extension
       {"typeHierarchyProvider", true},
       {"memoryUsageProvider", true}, // clangd extension
       {"compilationDatabase",        // clangd extension
        llvm::json::Object{{"automaticReload", true}}},
       {"callHierarchyProvider", true},
+      {"clangdInlayHintsProvider", true},
   };
 
   {
     LSPBinder Binder(Handlers, *this);
     bindMethods(Binder, Params.capabilities);
     if (Opts.FeatureModules)
       for (auto &Mod : *Opts.FeatureModules)
         Mod.initializeLSP(Binder, Params.rawCapabilities, ServerCaps);
ServerCaps["codeActionProvider"] =
                                 {CodeAction::QUICKFIX_KIND,
                                  CodeAction::REFACTOR_KIND,
                                  CodeAction::INFO_KIND}}}
           : llvm::json::Value(true);
 
   if (Opts.FoldingRanges)
     ServerCaps["foldingRangeProvider"] = true;
 
-  // FIXME: once inlayHints can be disabled in config, always advertise.
-  if (Opts.InlayHints)
-    ServerCaps["clangdInlayHintsProvider"] = true;
-
   std::vector<llvm::StringRef> Commands;
   for (llvm::StringRef Command : Handlers.CommandHandlers.keys())
     Commands.push_back(Command);
   llvm::sort(Commands);
   ServerCaps["executeCommandProvider"] =
       llvm::json::Object{{"commands", Commands}};
 
   llvm::json::Object Result{

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

 #include "TidyProvider.h"
 #include "Transport.h"
 #include "index/Background.h"
 #include "index/Index.h"
 #include "index/Merge.h"
 #include "index/ProjectAware.h"
 #include "index/Serialization.h"
 #include "index/remote/Client.h"
-#include "refactor/Rename.h"
 #include "support/Path.h"
 #include "support/Shutdown.h"
 #include "support/ThreadCrashReporter.h"
 #include "support/ThreadsafeFS.h"
 #include "support/Trace.h"
 #include "clang/Format/Format.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/SmallString.h"

 RetiredFlag<bool> EnableIndex("index");
 RetiredFlag<bool> SuggestMissingIncludes("suggest-missing-includes");
 RetiredFlag<bool> RecoveryAST("recovery-ast");
 RetiredFlag<bool> RecoveryASTType("recovery-ast-type");
 RetiredFlag<bool> AsyncPreamble("async-preamble");
 RetiredFlag<bool> CollectMainFileRefs("collect-main-file-refs");
 RetiredFlag<bool> CrossFileRename("cross-file-rename");
 RetiredFlag<std::string> ClangTidyChecks("clang-tidy-checks");
+RetiredFlag<std::string> InlayHints("inlay-hints");
 
 opt<int> LimitResults{
     "limit-results",
     cat(Features),
     desc("Limit the number of results returned by clangd. "
          "0 means no limit (default=100)"),
     init(100),
 };

 opt<bool> FoldingRanges{
     "folding-ranges",
     cat(Features),
     desc("Enable preview of FoldingRanges feature"),
     init(false),
     Hidden,
 };
 
-opt<bool> InlayHints{
-    "inlay-hints",
-    cat(Features),
-    desc("Enable InlayHints feature"),
-    init(ClangdLSPServer::Options().InlayHints),
-    // FIXME: allow inlayHints to be disabled in Config and remove this option.
-    Hidden,
-};
-
 opt<unsigned> WorkerThreadsCount{
     "j",
     cat(Misc),
     desc("Number of async workers used by clangd. Background index also "
          "uses this many workers."),
     init(getDefaultAsyncThreadsCount()),
 };
 
if (StaticIdx) {
     IdxStack.emplace_back(
         std::make_unique<MergedIndex>(PAI.get(), IdxStack.back().get()));
     Opts.StaticIndex = IdxStack.back().get();
   } else {
     Opts.StaticIndex = PAI.get();
   }
   Opts.AsyncThreadsCount = WorkerThreadsCount;
   Opts.FoldingRanges = FoldingRanges;
-  Opts.InlayHints = InlayHints;
   Opts.MemoryCleanup = getMemoryCleanupFunction();
 
   Opts.CodeComplete.IncludeIneligibleResults = IncludeIneligibleResults;
   Opts.CodeComplete.Limit = LimitResults;
   if (CompletionStyle.getNumOccurrences())
     Opts.CodeComplete.BundleOverloads = CompletionStyle != Detailed;
   Opts.CodeComplete.ShowOrigins = ShowOrigins;
   Opts.CodeComplete.InsertIncludes = HeaderInsertion;