Tell whether file/folder for include completions.

[ilya-biryukov]

A drive-by comment.
Would it be cleaner to pass this information from clang? Relying on completion label seems shaky.

[kadircet]

In D52547#1246701, @ilya-biryukov wrote:

A drive-by comment.
Would it be cleaner to pass this information from clang? Relying on completion label seems shaky.

Actually I also wanted to do that at first, but then wasn't really sure whether we should introduce a new contextkind or not, because it is more about lsp and wasn't sure if it would be widely applicable to have a distinction between file/directory(folder) as a completion context kind.
WDYT @sammccall , would introducing a new completion context carry its weight?

[sammccall]

In D52547#1247794, @kadircet wrote:

In D52547#1246701, @ilya-biryukov wrote:

A drive-by comment.
Would it be cleaner to pass this information from clang? Relying on completion label seems shaky.

Actually I also wanted to do that at first, but then wasn't really sure whether we should introduce a new contextkind or not, because it is more about lsp and wasn't sure if it would be widely applicable to have a distinction between file/directory(folder) as a completion context kind.
WDYT @sammccall , would introducing a new completion context carry its weight?

What Ilya proposes would indeed be cleaner - I think we could attach directory_entry or path/file_type to the completion result.

On the other hand while this is a hack, it's simple and it works, and the cleaner solution doesn't bring any concrete benefit at this point.

I think we should leave this be and revisit if we start querying headers from the index. (At that point we'll want more robust path info to deduplicate sema and index results).

clangd/CodeComplete.cpp

352

this probably deserves at least a comment mentioning that Sema could provide more semantic info here.

clangd/Protocol.h

706–714

This is a type outside of the core must-be-supported range, so we probably need to add the logic to ClangdLSPServer to respect the client capabilities (see adjustKindToCapability). This could be a separate patch, as it's basically plumbing.

[kadircet]

Preparing the patch to respect client capabilities.

• Add other itemkinds as well.
• Address comments.

clangd/CodeComplete.cpp

if (C.SemaResult) {
             (C.SemaResult->Kind == CodeCompletionResult::RK_Pattern))
           if (const auto *D = C.SemaResult->getDeclaration())
             if (const auto *ND = llvm::dyn_cast<NamedDecl>(D))
               Completion.Scope =
                   splitQualifiedName(printQualifiedName(*ND)).first;
       }
       Completion.Kind = toCompletionItemKind(
           C.SemaResult->Kind, C.SemaResult->Declaration, ContextKind);
+      // Sema could provide more info on whether the completion was a file or
+      // folder.
+      if (Completion.Kind == CompletionItemKind::File &&
+          Completion.Name.back() == '/')
+        Completion.Kind = CompletionItemKind::Folder;
       for (const auto &FixIt : C.SemaResult->FixIts) {
         Completion.FixIts.push_back(
             toTextEdit(FixIt, ASTCtx.getSourceManager(), ASTCtx.getLangOpts()));
       }
       std::sort(Completion.FixIts.begin(), Completion.FixIts.end(),
                 [](const TextEdit &X, const TextEdit &Y) {
                   return std::tie(X.range.start.line, X.range.start.character) <
                          std::tie(Y.range.start.line, Y.range.start.character);

clangd/Protocol.h

enum class CompletionItemKind {
   Property = 10,
   Unit = 11,
   Value = 12,
   Enum = 13,
   Keyword = 14,
   Snippet = 15,
   Color = 16,
   File = 17,
   Reference = 18,
+  Folder = 19,
+  EnumMember = 20,
+  Constant = 21,
+  Struct = 22,
+  Event = 23,
+  Operator = 24,
+  TypeParameter = 25,
 };
 
 /// Defines whether the insert text in a completion item should be interpreted
 /// as plain text or a snippet.
 enum class InsertTextFormat {
   Missing = 0,
   /// The primary text to be inserted is treated as a plain string.
   PlainText = 1,
   /// The primary text to be inserted is treated as a snippet.

unittests/clangd/CodeCompleteTests.cpp

TEST(SignatureHelpTest, ConstructorInitializeFields) {
     EXPECT_THAT(Results.signatures, UnorderedElementsAre(
             Sig("A(int)", {"int"}),
             Sig("A(A &&)", {"A &&"}),
             Sig("A(const A &)", {"const A &"})
         ));
   }
 }
 
+TEST(CompletionTest, IncludedCompletionKinds) {
+  MockFSProvider FS;
+  MockCompilationDatabase CDB;
+  std::string Subdir = testPath("sub");
+  std::string SearchDirArg = (llvm::Twine("-I") + Subdir).str();
+  CDB.ExtraClangFlags = {SearchDirArg.c_str()};
+  std::string BarHeader = testPath("sub/bar.h");
+  FS.Files[BarHeader] = "";
+  IgnoreDiagnostics DiagConsumer;
+  ClangdServer Server(CDB, FS, DiagConsumer, ClangdServer::optsForTest());
+  auto Results = completions(Server,
+      R"cpp(
+        #include "^"
+      )cpp"
+      );
+  EXPECT_THAT(Results.Completions,
+              AllOf(Has("sub/", CompletionItemKind::Folder),
+                    Has("bar.h\"", CompletionItemKind::File)));
+}
+
+
 } // namespace
 } // namespace clangd
 } // namespace clang