Author: Noustaa Date: 2025-05-12T14:22:27-04:00 New Revision: bfd2ef765957307d8a02f72cf6d67de5d3977f10
URL: https://github.com/llvm/llvm-project/commit/bfd2ef765957307d8a02f72cf6d67de5d3977f10 DIFF: https://github.com/llvm/llvm-project/commit/bfd2ef765957307d8a02f72cf6d67de5d3977f10.diff LOG: [clangd] Add CodePatterns config option under Completion (#137613) Allows enabling/disabling code pattern & snippet suggestions during code completion. Resolves https://github.com/clangd/clangd/discussions/1867 Added: Modified: clang-tools-extra/clangd/ClangdServer.cpp clang-tools-extra/clangd/CodeComplete.cpp clang-tools-extra/clangd/CodeComplete.h clang-tools-extra/clangd/Config.h clang-tools-extra/clangd/ConfigCompile.cpp clang-tools-extra/clangd/ConfigFragment.h clang-tools-extra/clangd/ConfigYAML.cpp clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp clang-tools-extra/clangd/unittests/ConfigYAMLTests.cpp Removed: ################################################################################ diff --git a/clang-tools-extra/clangd/ClangdServer.cpp b/clang-tools-extra/clangd/ClangdServer.cpp index 52844129834c3..b499683621f53 100644 --- a/clang-tools-extra/clangd/ClangdServer.cpp +++ b/clang-tools-extra/clangd/ClangdServer.cpp @@ -457,6 +457,7 @@ void ClangdServer::codeComplete(PathRef File, Position Pos, CodeCompleteOpts.ArgumentLists = Config::current().Completion.ArgumentLists; CodeCompleteOpts.InsertIncludes = Config::current().Completion.HeaderInsertion; + CodeCompleteOpts.CodePatterns = Config::current().Completion.CodePatterns; // FIXME(ibiryukov): even if Preamble is non-null, we may want to check // both the old and the new version in case only one of them matches. CodeCompleteResult Result = clangd::codeComplete( diff --git a/clang-tools-extra/clangd/CodeComplete.cpp b/clang-tools-extra/clangd/CodeComplete.cpp index 0eb196fbad46a..14679fea6ac8a 100644 --- a/clang-tools-extra/clangd/CodeComplete.cpp +++ b/clang-tools-extra/clangd/CodeComplete.cpp @@ -926,7 +926,8 @@ struct CompletionRecorder : public CodeCompleteConsumer { // FIXME: in case there is no future sema completion callback after the // recovery mode, we might still want to provide some results (e.g. trivial // identifier-based completion). - if (Context.getKind() == CodeCompletionContext::CCC_Recovery) { + CodeCompletionContext::Kind ContextKind = Context.getKind(); + if (ContextKind == CodeCompletionContext::CCC_Recovery) { log("Code complete: Ignoring sema code complete callback with Recovery " "context."); return; @@ -950,6 +951,12 @@ struct CompletionRecorder : public CodeCompleteConsumer { // Retain the results we might want. for (unsigned I = 0; I < NumResults; ++I) { auto &Result = InResults[I]; + if (Config::current().Completion.CodePatterns == + Config::CodePatternsPolicy::None && + Result.Kind == CodeCompletionResult::RK_Pattern && + // keep allowing the include files autocomplete suggestions + ContextKind != CodeCompletionContext::CCC_IncludedFile) + continue; // Class members that are shadowed by subclasses are usually noise. if (Result.Hidden && Result.Declaration && Result.Declaration->isCXXClassMember()) @@ -2153,7 +2160,8 @@ class CodeCompleteFlow { clang::CodeCompleteOptions CodeCompleteOptions::getClangCompleteOpts() const { clang::CodeCompleteOptions Result; - Result.IncludeCodePatterns = EnableSnippets; + Result.IncludeCodePatterns = + EnableSnippets && (CodePatterns != Config::CodePatternsPolicy::None); Result.IncludeMacros = true; Result.IncludeGlobals = true; // We choose to include full comments and not do doxygen parsing in diff --git a/clang-tools-extra/clangd/CodeComplete.h b/clang-tools-extra/clangd/CodeComplete.h index 83d347054119e..1cf3b41119043 100644 --- a/clang-tools-extra/clangd/CodeComplete.h +++ b/clang-tools-extra/clangd/CodeComplete.h @@ -111,6 +111,9 @@ struct CodeCompleteOptions { Config::ArgumentListsPolicy ArgumentLists = Config::ArgumentListsPolicy::FullPlaceholders; + /// Whether to suggest code patterns & snippets or not in completion + Config::CodePatternsPolicy CodePatterns = Config::CodePatternsPolicy::All; + /// Whether to use the clang parser, or fallback to text-based completion /// (using identifiers in the current file and symbol indexes). enum CodeCompletionParse { diff --git a/clang-tools-extra/clangd/Config.h b/clang-tools-extra/clangd/Config.h index 2891a6d1e77b0..83e0fce847271 100644 --- a/clang-tools-extra/clangd/Config.h +++ b/clang-tools-extra/clangd/Config.h @@ -152,6 +152,11 @@ struct Config { NeverInsert // Never insert headers as part of code completion }; + enum class CodePatternsPolicy { + All, // Suggest all code patterns and snippets + None // Suggest none of the code patterns and snippets + }; + /// Configures code completion feature. struct { /// Whether code completion includes results that are not visible in current @@ -161,6 +166,8 @@ struct Config { ArgumentListsPolicy ArgumentLists = ArgumentListsPolicy::FullPlaceholders; /// Controls if headers should be inserted when completions are accepted HeaderInsertionPolicy HeaderInsertion = HeaderInsertionPolicy::IWYU; + /// Enables code patterns & snippets suggestions + CodePatternsPolicy CodePatterns = CodePatternsPolicy::All; } Completion; /// Configures hover feature. diff --git a/clang-tools-extra/clangd/ConfigCompile.cpp b/clang-tools-extra/clangd/ConfigCompile.cpp index 13c2405e76df7..35d35f747a868 100644 --- a/clang-tools-extra/clangd/ConfigCompile.cpp +++ b/clang-tools-extra/clangd/ConfigCompile.cpp @@ -707,6 +707,17 @@ struct FragmentCompiler { C.Completion.HeaderInsertion = *Val; }); } + + if (F.CodePatterns) { + if (auto Val = compileEnum<Config::CodePatternsPolicy>("CodePatterns", + *F.CodePatterns) + .map("All", Config::CodePatternsPolicy::All) + .map("None", Config::CodePatternsPolicy::None) + .value()) + Out.Apply.push_back([Val](const Params &, Config &C) { + C.Completion.CodePatterns = *Val; + }); + } } void compile(Fragment::HoverBlock &&F) { diff --git a/clang-tools-extra/clangd/ConfigFragment.h b/clang-tools-extra/clangd/ConfigFragment.h index 2363b483ab96d..9e00dbc9dc90a 100644 --- a/clang-tools-extra/clangd/ConfigFragment.h +++ b/clang-tools-extra/clangd/ConfigFragment.h @@ -349,6 +349,11 @@ struct Fragment { /// symbol is forward-declared /// "Never": Never insert headers std::optional<Located<std::string>> HeaderInsertion; + /// Will suggest code patterns & snippets. + /// Values are Config::CodePatternsPolicy: + /// All => enable all code patterns and snippets suggestion + /// None => disable all code patterns and snippets suggestion + std::optional<Located<std::string>> CodePatterns; }; CompletionBlock Completion; diff --git a/clang-tools-extra/clangd/ConfigYAML.cpp b/clang-tools-extra/clangd/ConfigYAML.cpp index 47c6e1cd0f7e7..ff457d8701307 100644 --- a/clang-tools-extra/clangd/ConfigYAML.cpp +++ b/clang-tools-extra/clangd/ConfigYAML.cpp @@ -249,6 +249,10 @@ class Parser { if (auto HeaderInsertion = scalarValue(N, "HeaderInsertion")) F.HeaderInsertion = *HeaderInsertion; }); + Dict.handle("CodePatterns", [&](Node &N) { + if (auto CodePatterns = scalarValue(N, "CodePatterns")) + F.CodePatterns = *CodePatterns; + }); Dict.parse(N); } diff --git a/clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp b/clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp index 718bee2e40b11..311f0d98904ad 100644 --- a/clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp +++ b/clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp @@ -3326,6 +3326,40 @@ TEST(CompletionTest, AllScopesCompletion) { kind(CompletionItemKind::EnumMember)))); } +TEST(CompletionTest, NoCodePatternsIfDisabled) { + clangd::CodeCompleteOptions Opts = {}; + Opts.EnableSnippets = true; + Opts.CodePatterns = Config::CodePatternsPolicy::None; + + auto Results = completions(R"cpp( + void function() { + /// Trying to trigger "for (init-statement; condition; inc-expression) + /// {statements}~" code pattern + for^ + } + )cpp", + {}, Opts); + + EXPECT_THAT(Results.Completions, + Not(Contains(kind(CompletionItemKind::Snippet)))); +} + +TEST(CompletionTest, CompleteIncludeIfCodePatternsNone) { + clangd::CodeCompleteOptions Opts = {}; + Opts.EnableSnippets = true; + Opts.CodePatterns = Config::CodePatternsPolicy::None; + + Annotations Test(R"cpp(#include "^)cpp"); + auto TU = TestTU::withCode(Test.code()); + TU.AdditionalFiles["foo/bar.h"] = ""; + TU.ExtraArgs.push_back("-I" + testPath("foo")); + + auto Results = completions(TU, Test.point(), {}, Opts); + EXPECT_THAT(Results.Completions, + AllOf(has("foo/", CompletionItemKind::Folder), + has("bar.h\"", CompletionItemKind::File))); +} + TEST(CompletionTest, NoQualifierIfShadowed) { clangd::CodeCompleteOptions Opts = {}; Opts.AllScopes = true; diff --git a/clang-tools-extra/clangd/unittests/ConfigYAMLTests.cpp b/clang-tools-extra/clangd/unittests/ConfigYAMLTests.cpp index 979d725461fd0..d71b8d5f9302a 100644 --- a/clang-tools-extra/clangd/unittests/ConfigYAMLTests.cpp +++ b/clang-tools-extra/clangd/unittests/ConfigYAMLTests.cpp @@ -217,6 +217,19 @@ TEST(ParseYAML, AllScopesWarn) { EXPECT_THAT(Results[0].Completion.AllScopes, testing::Eq(std::nullopt)); } +TEST(ParseYAML, CodePatterns) { + CapturedDiags Diags; + Annotations YAML(R"yaml( + Completion: + CodePatterns: None + )yaml"); + auto Results = + Fragment::parseYAML(YAML.code(), "config.yaml", Diags.callback()); + ASSERT_THAT(Diags.Diagnostics, IsEmpty()); + ASSERT_EQ(Results.size(), 1u); + EXPECT_THAT(Results[0].Completion.CodePatterns, llvm::ValueIs(val("None"))); +} + TEST(ParseYAML, ShowAKA) { CapturedDiags Diags; Annotations YAML(R"yaml( _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
