Add bundled pretty-printers for LLDB #2928

artemmukhin · 2018-10-11T14:53:20Z

Current version of LLDB pretty-printer for Rust is very primitive. For example, it doesn't support children-based representation of data (synthetic children).

I started to develop a new LLDB pretty-printer for Rust. This PR adds:

Vec: size as summary and elements as synthetic children;
String and &str: value as summary, also supports UTF-8;
Regular structures, arrays, and slices: LLDB already supports it.

debugger/src/main/kotlin/org/rust/debugger/prettyPrinters/lldb_pretty_printer.py

matklad

Might be a good idea to upstream pretty printer changes?

debugger/src/main/kotlin/org/rust/debugger/prettyPrinters/lldb_pretty_printer.py

mchernyavsky · 2018-10-11T21:32:11Z

Flake8's output:

lldb_pretty_printer.py:18:80: E501 line too long (113 > 79 characters)
lldb_pretty_printer.py:19:80: E501 line too long (98 > 79 characters)
lldb_pretty_printer.py:30:80: E501 line too long (94 > 79 characters)
lldb_pretty_printer.py:38:80: E501 line too long (89 > 79 characters)
lldb_pretty_printer.py:49:9: E722 do not use bare except'
lldb_pretty_printer.py:58:80: E501 line too long (112 > 79 characters)

Undin · 2018-10-11T21:34:18Z

@matklad yep, we are going to do it

Undin · 2018-10-11T21:41:49Z

@mchernyavsky I think the warning about 80 symbols per line doesn't really make sense. Looks like we are not going to modify this code via console editors so we can easily use restriction in 120 symbols

vlad20012 · 2018-10-12T05:15:29Z

Let's move lldb_pretty_printer.py from src/main/kotiln to src/main/resources. Kotlin directory should contains only kotlin sources

debugger/src/main/kotlin/org/rust/debugger/UpdatePrettyPrintersComponent.kt

Undin

The current implementation doesn't work for me now. But I'm absolutely sure that some previous version worked pretty well on my mac.
Could you check it?

Undin · 2018-10-20T13:19:02Z

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

+
+    private fun getSourceCode(): String {
+        val resourceStream = LLDBJetbrainsPrettyPrinter::class.java.classLoader.getResourceAsStream("$PP_RESOURCE_DIR/$LLDB_PP")
+        return resourceStream.bufferedReader().use { it.readText() }


readText potentially throws IOException

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

Undin · 2018-10-20T13:47:52Z

debugger/src/main/kotlin/org/rust/debugger/UpdatePrettyPrintersComponent.kt

+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.components.ApplicationComponent
+
+class UpdatePrettyPrintersComponent : ApplicationComponent, Disposable {


UnpackPrettyPrintersComponent looks more suitable here

Undin · 2018-10-20T13:49:02Z

debugger/src/main/kotlin/org/rust/debugger/UpdatePrettyPrintersComponent.kt

+        // NOP
+    }
+
+    override fun dispose() = disposeComponent()


Looks like that we don't need to implement Disposable and implement custom disposeComponent.

debugger/src/main/kotlin/org/rust/debugger/runconfig/RsDebugRunner.kt

Undin · 2018-10-20T13:56:57Z

debugger/src/main/kotlin/org/rust/debugger/settings/RsDebuggerSettingsConfigurable.kt

@@ -18,21 +18,28 @@ class RsDebuggerSettingsConfigurable(
    private val isRendersEnabledCheckbox: JBCheckBox = JBCheckBox("Enable Rust library renders")
    private var isRendersEnabled: Boolean by CheckboxDelegate(isRendersEnabledCheckbox)

+    private val isBundledPrintersEnabledCheckbox: JBCheckBox = JBCheckBox("Enable bundled IntelliJ Rust pretty-printers")


Let's shorten label to Enable bundled pretty-printers

artemmukhin · 2018-10-22T12:29:18Z

@Undin thank you for the review! Now it should work fine again.

debugger/src/main/kotlin/org/rust/debugger/runconfig/RsLocalDebugProcess.kt

artemmukhin · 2018-10-25T12:26:49Z

Initially, I was going to use my pretty-printers along with the original ones by using regular expressions (non-trivial regexes for my printers and trivial .* for original). But unfortunately, LLDB doesn't preserve the order of regexes: sometimes Vec<i32> matches with .* (instead of Vec<.+>) and goes to the original printer instead of mine. Also, LLDB doesn't support lookahead regexes, so I can't just rewrite .* with a negation of the others. Therefore, I decided to get rid of regexes at all and use pretty-printers separately to avoid conflicts: either bundled or original.

Now, instead of regexes, I use two lookups (synthetic and summary) to determine which pretty-printer should be used for a given value.

Undin

In general, it already works better than default lldb pretty printers 😄

prettyPrinters/lookup.py

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

debugger/src/main/kotlin/org/rust/debugger/settings/RsDebuggerSettingsConfigurable.kt

debugger/src/main/kotlin/org/rust/debugger/runconfig/RsLocalDebugProcess.kt

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

prettyPrinters/providers.py

Undin · 2018-10-29T11:19:07Z

debugger/src/main/kotlin/org/rust/debugger/settings/RsDebuggerSettingsConfigurable.kt

 import javax.swing.JComponent

 class RsDebuggerSettingsConfigurable(
    private val settings: RsDebuggerSettings
 ) : SearchableConfigurable {

-    private val isRendersEnabledCheckbox: JBCheckBox = JBCheckBox("Enable Rust library renders")
-    private var isRendersEnabled: Boolean by CheckboxDelegate(isRendersEnabledCheckbox)
+    private val isLLDB = CPPToolchains.getInstance().defaultToolchain?.debuggerKind?.isLLDB() == true


Unfortunately, we can't just read toolchain type here because

RsDebuggerSettingsConfigurable is not instantiated on each opening of the corresponding ui panel in settings

A user can change default toolchain and we should modify our ui on each change

Let's subscribe on CPPToolchainsConfigurable.TOPIC and do the corresponding changes in ui on toolchain change

Don't forget to unsubscribe in disposeUIResources

Using CPPToolchainsConfigurable.TOPIC is a rather tricky business, because of the lifecycle of the configurables. I'd suggest not to go that way.
If you absolutely have to separate GDB/LLDB settings, it will be much easier to show both settings groups (for GDB and for LLDB)

@amakeev Oh, as you are much more aware of CLion related things, let's do it in this way!

If you absolutely have to separate GDB/LLDB settings

Maybe there is a better solution, but the current one allows us to release own pretty printers partially. Also, we still use formatters from rustup distribution as defaut variant for now.
We'll merge these settings and make bundled printers default when we implement all basic features available with formatters from rustup distribution

Just in case: you're comment about A user can change default toolchain is totally valid. I meant that making the correct listener between two configurables is not straightforward.

Undin · 2018-10-29T11:22:46Z

debugger/src/main/kotlin/org/rust/debugger/settings/RsDebuggerSettingsConfigurable.kt

+
+    private val dataFormattersLabel = Label("Data formatters")
+
+    private val dataFormatters = ComboBox<DataFormatters>().apply {


Looks like it's better to separate properties for gdb and lldb toolchains. At least, until we have bundled pretty printers for gdb

debugger/src/main/kotlin/org/rust/debugger/settings/RsDebuggerSettingsConfigurable.kt

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

Undin

The latest minor comments:)
Also, behaviour of bundled renders differs from default rust and C++ renders in case of scalar types:

Bundled:

Default:

But it's ok for now

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

prettyPrinters/providers.py

src/main/kotlin/org/rust/openapiext/utils.kt

artemmukhin · 2018-10-31T11:13:25Z

@Undin thank you for attention! Now scalar types render correctly.

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt

Undin · 2018-10-31T16:53:27Z

bors r+

2928: Add bundled pretty-printers for LLDB r=Undin a=ortem Current version of [LLDB pretty-printer for Rust](https://github.com/rust-lang/rust/blob/master/src/etc/lldb_rust_formatters.py) is very primitive. For example, it doesn't support children-based representation of data (synthetic children). I started to develop a new LLDB pretty-printer for Rust. This PR adds: * `Vec`: size as summary and elements as synthetic children; * `String` and `&str`: value as summary, also supports UTF-8; * Regular structures, arrays, and slices: LLDB already supports it. <img width="438" alt="screen shot 2018-10-31 at 14 28 36" src="https://user-images.githubusercontent.com/4854600/47785295-554f9580-dd19-11e8-94ae-dffe1f930e6e.png"> <img width="394" alt="screen shot 2018-10-31 at 14 28 50" src="https://user-images.githubusercontent.com/4854600/47785297-554f9580-dd19-11e8-8821-e941d004091a.png"> <img width="451" alt="screen shot 2018-10-31 at 14 09 52" src="https://user-images.githubusercontent.com/4854600/47784453-b75acb80-dd16-11e8-83db-7e2313fd1cf3.png"> Co-authored-by: ortem <[email protected]>

bors · 2018-10-31T17:48:24Z

Build succeeded

artemmukhin changed the title ~~WIP: Bundled pretty-printer for LLDB (std_vec support)~~ WIP: Add bundled pretty-printer for LLDB (Vec support) Oct 11, 2018

Undin reviewed Oct 11, 2018

View reviewed changes

debugger/src/main/kotlin/org/rust/debugger/prettyPrinters/lldb_pretty_printer.py Outdated Show resolved Hide resolved

matklad reviewed Oct 11, 2018

View reviewed changes

artemmukhin force-pushed the debugger branch 5 times, most recently from c8da71c to cbcab57 Compare October 12, 2018 11:19

matklad reviewed Oct 13, 2018

View reviewed changes

debugger/src/main/kotlin/org/rust/debugger/UpdatePrettyPrintersComponent.kt Outdated Show resolved Hide resolved

artemmukhin force-pushed the debugger branch 2 times, most recently from 37cf907 to 530667a Compare October 16, 2018 15:38

artemmukhin changed the title ~~WIP: Add bundled pretty-printer for LLDB (Vec support)~~ Add bundled pretty-printer for LLDB (Vec support) Oct 16, 2018

artemmukhin assigned Undin Oct 16, 2018

Undin reviewed Oct 20, 2018

View reviewed changes

artemmukhin force-pushed the debugger branch from 530667a to ad5b719 Compare October 22, 2018 12:26

artemmukhin force-pushed the debugger branch 2 times, most recently from a034e3e to a60eb7d Compare October 23, 2018 12:04

Undin reviewed Oct 23, 2018

View reviewed changes

debugger/src/main/kotlin/org/rust/debugger/runconfig/RsLocalDebugProcess.kt Outdated Show resolved Hide resolved

artemmukhin changed the title ~~Add bundled pretty-printer for LLDB (Vec support)~~ Add bundled pretty-printers for LLDB Oct 25, 2018

artemmukhin force-pushed the debugger branch from 9f7ab0e to aab10bf Compare October 25, 2018 12:07

artemmukhin force-pushed the debugger branch 2 times, most recently from 88a9e37 to 6dfe25a Compare October 29, 2018 10:48

Undin reviewed Oct 29, 2018

View reviewed changes

artemmukhin force-pushed the debugger branch from eb94610 to 32a970a Compare October 30, 2018 11:05

artemmukhin force-pushed the debugger branch 2 times, most recently from de8cd52 to add99ce Compare October 30, 2018 11:51

Undin reviewed Oct 30, 2018

View reviewed changes

artemmukhin force-pushed the debugger branch 3 times, most recently from 376cfa4 to 23a9b43 Compare October 30, 2018 15:10

Undin reviewed Oct 30, 2018

View reviewed changes

artemmukhin force-pushed the debugger branch 2 times, most recently from 830c251 to bb5d390 Compare October 31, 2018 11:11

artemmukhin added the subsystem::debugger Issues related to debugger label Oct 31, 2018

artemmukhin force-pushed the debugger branch from bb5d390 to 4ae49dc Compare October 31, 2018 12:52

Undin reviewed Oct 31, 2018

View reviewed changes

debugger/src/main/kotlin/org/rust/debugger/PrettyPrinters.kt Outdated Show resolved Hide resolved

artemmukhin added 3 commits October 31, 2018 19:51

Add bundled pretty-printers support

5af6a31

Bundled pretty-printer for LLDB: lookup and Vec, String, &str providers

f3ad26a

Cleanup

3496337

artemmukhin force-pushed the debugger branch from 4ae49dc to 3496337 Compare October 31, 2018 16:51

bors bot merged commit 3496337 into intellij-rust:master Oct 31, 2018

artemmukhin deleted the debugger branch November 1, 2018 09:02

artemmukhin mentioned this pull request Nov 6, 2018

Several bugs related to enum debugging rust-lang/rust#55586

Closed


		private val dataFormattersLabel = Label("Data formatters")

		private val dataFormatters = ComboBox<DataFormatters>().apply {

Add bundled pretty-printers for LLDB #2928

Add bundled pretty-printers for LLDB #2928

Uh oh!

Conversation

artemmukhin commented Oct 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

matklad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mchernyavsky commented Oct 11, 2018

Uh oh!

Undin commented Oct 11, 2018

Uh oh!

Undin commented Oct 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vlad20012 commented Oct 12, 2018

Uh oh!

Uh oh!

Undin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

artemmukhin commented Oct 22, 2018

Uh oh!

Uh oh!

artemmukhin commented Oct 25, 2018

Uh oh!

Undin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Undin Oct 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Undin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

artemmukhin commented Oct 31, 2018

artemmukhin commented Oct 11, 2018 •

edited

Loading

Undin commented Oct 11, 2018 •

edited

Loading

Undin left a comment •

edited

Loading

Undin left a comment •

edited

Loading

Undin Oct 29, 2018 •

edited

Loading