Skip to content

[clangd] Make EnableFunctionArgSnippets option string-typed #121178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 31, 2024
Merged

[clangd] Make EnableFunctionArgSnippets option string-typed #121178

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions clang-tools-extra/clangd/tool/ClangdMain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,13 +242,13 @@ opt<std::string> FallbackStyle{
init(clang::format::DefaultFallbackStyle),
};

opt<int> EnableFunctionArgSnippets{
opt<std::string> EnableFunctionArgSnippets{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also consider the following option, but up to you.

enum FunctionArgSnippetsFlag { True, False, None, ... };
opt<FunctionArgSnippetsFlag> EnableFunctionArgSnippets{...
  values(
    clEnumValN(FunctionArgSnippetsFlag::True, "true", ...),
    clEnumValN(FunctionArgSnippetsFlag::True, "True", ...),
    ...
  ),
};

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion. I tried this briefly, but I think it makes the --help output too noisy because it prints a separate line for each spelling of "true", "True", etc.

"function-arg-placeholders",
cat(Features),
desc("When disabled (0), completions contain only parentheses for "
"function calls. When enabled (1), completions also contain "
"placeholders for method parameters"),
init(-1),
init("-1"),
};

opt<CodeCompleteOptions::IncludeInsertion> HeaderInsertion{
Expand Down Expand Up @@ -635,6 +635,22 @@ loadExternalIndex(const Config::ExternalIndexSpec &External,
llvm_unreachable("Invalid ExternalIndexKind.");
}

std::optional<bool> shouldEnableFunctionArgSnippets() {
std::string Val = EnableFunctionArgSnippets;
// Accept the same values that a bool option parser would, but also accept
// -1 to indicate "unspecified", in which case the ArgumentListsPolicy
// config option will be respected.
if (Val == "1" || Val == "true" || Val == "True" || Val == "TRUE")
return true;
if (Val == "0" || Val == "false" || Val == "False" || Val == "FALSE")
return false;
if (Val != "-1")
elog("Value specified by --function-arg-placeholders is invalid. Provide a "
"boolean value or leave unspecified to use ArgumentListsPolicy from "
"config instead.");
return std::nullopt;
}

class FlagsConfigProvider : public config::Provider {
private:
config::CompiledFragment Frag;
Expand Down Expand Up @@ -695,10 +711,9 @@ class FlagsConfigProvider : public config::Provider {
BGPolicy = Config::BackgroundPolicy::Skip;
}

if (EnableFunctionArgSnippets >= 0) {
ArgumentLists = EnableFunctionArgSnippets
? Config::ArgumentListsPolicy::FullPlaceholders
: Config::ArgumentListsPolicy::Delimiters;
if (std::optional<bool> Enable = shouldEnableFunctionArgSnippets()) {
ArgumentLists = *Enable ? Config::ArgumentListsPolicy::FullPlaceholders
: Config::ArgumentListsPolicy::Delimiters;
}

Frag = [=](const config::Params &, Config &C) {
Expand Down
Loading