[lldb] Make sure completions don't end with newlines #117054
Conversation
The logic that prints completions and their descriptions assumes neither the completion itself nor the description ends with a newline. I considered making this an assert, but decided against it as completions can indirectly come from user input (e.g. oddly crafted names). Instead, avoid the potential for mistakes by defensively stripping them.
|
@llvm/pr-subscribers-lldb Author: Jonas Devlieghere (JDevlieghere) ChangesThe logic that prints completions and their descriptions assumes neither the completion itself nor the description ends with a newline. I considered making this an assert, but decided against it as completions can indirectly come from user input (e.g. oddly crafted names). Instead, avoid the potential for mistakes by defensively stripping them. Full diff: https://github.com/llvm/llvm-project/pull/117054.diff 1 Files Affected:
diff --git a/lldb/include/lldb/Utility/CompletionRequest.h b/lldb/include/lldb/Utility/CompletionRequest.h
index 650158a197dbd9..865d6db5762984 100644
--- a/lldb/include/lldb/Utility/CompletionRequest.h
+++ b/lldb/include/lldb/Utility/CompletionRequest.h
@@ -52,8 +52,8 @@ class CompletionResult {
public:
Completion(llvm::StringRef completion, llvm::StringRef description,
CompletionMode mode)
- : m_completion(completion.str()), m_descripton(description.str()),
- m_mode(mode) {}
+ : m_completion(completion.rtrim().str()),
+ m_descripton(description.rtrim().str()), m_mode(mode) {}
const std::string &GetCompletion() const { return m_completion; }
const std::string &GetDescription() const { return m_descripton; }
CompletionMode GetMode() const { return m_mode; }
|
|
I get the "description" part, but I'm somewhat confused about the "completion". How does a newline (trailing or not) get there? Like, you can't actually type something which includes a newline, right? I'm wondering if we should disallow these at a higher level... |
I didn't actually find a completion where that was the case, but it seemed simple enough to be defensive for both. Like I said in the description, I considered an assertion but technically this is user input. I didn't actually try this, but what I was thinking of is something like a newline in |
The logic that prints completions and their descriptions assumes neither the completion itself nor the description ends with a newline. I considered making this an assert, but decided against it as completions can indirectly come from user input (e.g. oddly crafted names). Instead, avoid the potential for mistakes by defensively stripping them. (cherry picked from commit 4b5a8d6)
…4b5a8d683589 [🍒 swift/release/6.1] [lldb] Make sure completions don't end with newlines (llvm#117054)
The logic that prints completions and their descriptions assumes neither the completion itself nor the description ends with a newline. I considered making this an assert, but decided against it as completions can indirectly come from user input (e.g. oddly crafted names). Instead, avoid the potential for mistakes by defensively stripping them.