Skip to content

[lldb] Treat user aliases the same as built-ins when tab completing #65974

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 3 commits into from
Sep 13, 2023
Merged

[lldb] Treat user aliases the same as built-ins when tab completing #65974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e415b3
[lldb] Treat user aliases the same as built-ins when tab completing
DavidSpickett Sep 11, 2023
2763c7e
Explain use of he not h in abbreviation test.
DavidSpickett Sep 11, 2023
25e9792
Add explicit alias for h -> help instead of relying on the order of l…
DavidSpickett Sep 12, 2023
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
40 changes: 10 additions & 30 deletions lldb/source/Interpreter/CommandInterpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,11 @@ void CommandInterpreter::Initialize() {
if (cmd_obj_sp) {
AddAlias("history", cmd_obj_sp);
}

cmd_obj_sp = GetCommandSPExact("help");
if (cmd_obj_sp) {
AddAlias("h", cmd_obj_sp);
}
}

void CommandInterpreter::Clear() {
Expand Down Expand Up @@ -1227,36 +1232,11 @@ CommandObject *
CommandInterpreter::GetCommandObject(llvm::StringRef cmd_str,
StringList *matches,
StringList *descriptions) const {
CommandObject *command_obj =
GetCommandSP(cmd_str, false, true, matches, descriptions).get();

// If we didn't find an exact match to the command string in the commands,
// look in the aliases.

if (command_obj)
return command_obj;

command_obj = GetCommandSP(cmd_str, true, true, matches, descriptions).get();

if (command_obj)
return command_obj;

// If there wasn't an exact match then look for an inexact one in just the
// commands
command_obj = GetCommandSP(cmd_str, false, false, nullptr).get();

// Finally, if there wasn't an inexact match among the commands, look for an
// inexact match in both the commands and aliases.

if (command_obj) {
if (matches)
matches->AppendString(command_obj->GetCommandName());
if (descriptions)
descriptions->AppendString(command_obj->GetHelp());
return command_obj;
}

return GetCommandSP(cmd_str, true, false, matches, descriptions).get();
// Try to find a match among commands and aliases. Allowing inexact matches,
// but perferring exact matches.
return GetCommandSP(cmd_str, /*include_aliases=*/true, /*exact=*/false,
matches, descriptions)
.get();
}

CommandObject *CommandInterpreter::GetUserCommandObject(
Expand Down
18 changes: 7 additions & 11 deletions lldb/test/API/functionalities/completion/TestCompletion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,19 +618,15 @@ def test_command_unalias(self):

def test_command_aliases(self):
self.runCmd("command alias brkpt breakpoint")
# If there is an unambiguous completion from the built-in commands,
# we choose that.
self.complete_from_to("br", "breakpoint")
# Only if there is not, do we then look for an unambiguous completion
# from the user defined aliases.
# Exact matches are chosen if possible, even if there are longer
# completions we could use.
self.complete_from_to("b", "b ")
# Aliases are included in possible completions.
self.complete_from_to("br", ["breakpoint", "brkpt"])
# An alias can be the chosen completion.
self.complete_from_to("brk", "brkpt")

# Aliases are included when there's no exact match.
self.runCmd("command alias play breakpoint")
self.complete_from_to("pl", ["plugin", "platform", "play"])

# That list can also contain only aliases if there's no built-ins to
# match.
# The list can contain only aliases if there's no built-ins to match.
self.runCmd("command alias test_1 breakpoint")
self.runCmd("command alias test_2 breakpoint")
self.complete_from_to("test_", ["test_1", "test_2"])
Expand Down