1//===-- CompletionRequest.cpp ---------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "lldb/Utility/CompletionRequest.h"
10
11using namespace lldb;
12using namespace lldb_private;
13
14CompletionRequest::CompletionRequest(llvm::StringRef command_line,
15 unsigned raw_cursor_pos,
16 CompletionResult &result)
17 : m_command(command_line), m_raw_cursor_pos(raw_cursor_pos),
18 m_result(result) {
19 assert(raw_cursor_pos <= command_line.size() && "Out of bounds cursor?");
20
21 // We parse the argument up to the cursor, so the last argument in
22 // parsed_line is the one containing the cursor, and the cursor is after the
23 // last character.
24 llvm::StringRef partial_command(command_line.substr(Start: 0, N: raw_cursor_pos));
25 m_parsed_line = Args(partial_command);
26
27 if (GetParsedLine().GetArgumentCount() == 0) {
28 m_cursor_index = 0;
29 m_cursor_char_position = 0;
30 } else {
31 m_cursor_index = GetParsedLine().GetArgumentCount() - 1U;
32 m_cursor_char_position =
33 strlen(s: GetParsedLine().GetArgumentAtIndex(idx: m_cursor_index));
34 }
35
36 // The cursor is after a space but the space is not part of the argument.
37 // Let's add an empty fake argument to the end to make sure the completion
38 // code. Note: The space could be part of the last argument when it's quoted.
39 if (partial_command.ends_with(Suffix: " ") &&
40 !GetCursorArgumentPrefix().ends_with(Suffix: " "))
41 AppendEmptyArgument();
42}
43
44std::string CompletionResult::Completion::GetUniqueKey() const {
45
46 // We build a unique key for this pair of completion:description. We
47 // prefix the key with the length of the completion string. This prevents
48 // that we could get any collisions from completions pairs such as these:
49 // "foo:", "bar" would be "foo:bar", but will now be: "4foo:bar"
50 // "foo", ":bar" would be "foo:bar", but will now be: "3foo:bar"
51
52 std::string result;
53 result.append(str: std::to_string(val: m_completion.size()));
54 result.append(str: m_completion);
55 result.append(str: std::to_string(val: static_cast<int>(m_mode)));
56 result.append(s: ":");
57 result.append(str: m_descripton);
58 return result;
59}
60
61void CompletionResult::AddResult(llvm::StringRef completion,
62 llvm::StringRef description,
63 CompletionMode mode) {
64 Completion r(completion, description, mode);
65
66 // Add the completion if we haven't seen the same value before.
67 if (m_added_values.insert(key: r.GetUniqueKey()).second)
68 m_results.push_back(x: r);
69}
70
71void CompletionResult::GetMatches(StringList &matches) const {
72 matches.Clear();
73 for (const Completion &completion : m_results)
74 matches.AppendString(s: completion.GetCompletion());
75}
76
77void CompletionResult::GetDescriptions(StringList &descriptions) const {
78 descriptions.Clear();
79 for (const Completion &completion : m_results)
80 descriptions.AppendString(s: completion.GetDescription());
81}
82

source code of lldb/source/Utility/CompletionRequest.cpp