Add support for descriptions with command completions.
authorRaphael Isemann <teemperor@gmail.com>
Thu, 13 Sep 2018 21:26:00 +0000 (21:26 +0000)
committerRaphael Isemann <teemperor@gmail.com>
Thu, 13 Sep 2018 21:26:00 +0000 (21:26 +0000)
commit7f88829ceabef9ea9ff4743e8ba67f676d8c0968
treea6811b305d3e768aedfd9f73b41c1b95f5b2d651
parent9b3e7c365c3cd09954b7d3b4445d7b462bb3ec02
Add support for descriptions with command completions.

Summary:
This patch adds a framework for adding descriptions to the command completions we provide.
It also adds descriptions for completed top-level commands so that we can test this code.

Completions are in general supposed to be displayed alongside the completion itself. The descriptions
can be used to provide additional information about the completion to the user. Examples for descriptions
are function signatures when completing function calls in the expression command or the binary name
when providing completion for a symbol.

There is still some boilerplate code from the old completion API left in LLDB (mostly because the respective
APIs are reused for non-completion related purposes, so the CompletionRequest doesn't make sense to be
used), so that's why I still had to change some function signatures. Also, as the old API only passes around a
list of matches, and the descriptions are for these functions just another list, I had to add some code that
essentially just ensures that both lists are always the same side (e.g. all the manual calls to
`descriptions->AddString(X)` below a `matches->AddString(Y)` call).

The initial command descriptions that come with this patch are just reusing the existing
short help that is already added in LLDB.

An example completion with descriptions looks like this:
```
(lldb) pl
Available completions:
        platform -- Commands to manage and create platforms.
        plugin   -- Commands for managing LLDB plugins.
```

Reviewers: #lldb, jingham

Reviewed By: #lldb, jingham

Subscribers: jingham, JDevlieghere, lldb-commits

Differential Revision: https://reviews.llvm.org/D51175

llvm-svn: 342181
18 files changed:
lldb/include/lldb/API/SBCommandInterpreter.h
lldb/include/lldb/Core/IOHandler.h
lldb/include/lldb/Expression/REPL.h
lldb/include/lldb/Host/Editline.h
lldb/include/lldb/Interpreter/CommandInterpreter.h
lldb/include/lldb/Interpreter/CommandObject.h
lldb/include/lldb/Utility/CompletionRequest.h
lldb/packages/Python/lldbsuite/test/functionalities/completion/TestCompletion.py
lldb/packages/Python/lldbsuite/test/lldbtest.py
lldb/scripts/interface/SBCommandInterpreter.i
lldb/source/API/SBCommandInterpreter.cpp
lldb/source/Commands/CommandObjectMultiword.cpp
lldb/source/Core/IOHandler.cpp
lldb/source/Expression/REPL.cpp
lldb/source/Host/common/Editline.cpp
lldb/source/Interpreter/CommandInterpreter.cpp
lldb/source/Utility/CompletionRequest.cpp
lldb/unittests/Utility/CompletionRequestTest.cpp