rust debugger - add pretty representation for ManagedBuffer and other string-like types

.github/workflows/lldb-formatter-tests.yml

@@ -28,8 +28,8 @@ jobs:
       - name: Setup vscode-lldb
         run: |
           unzip codelldb-linux-x64.vsix -d vscode-lldb
-          mkdir -p $HOME/.vscode/extensions/vadimcn.vscode-lldb-1.11.0/
-          mv vscode-lldb/extension/* $HOME/.vscode/extensions/vadimcn.vscode-lldb-1.11.0/
+          mkdir -p $HOME/.vscode/extensions/vadimcn.vscode-lldb-1.11.1/
+          mv vscode-lldb/extension/* $HOME/.vscode/extensions/vadimcn.vscode-lldb-1.11.1/
 
       - name: Run the rust tests
         run: |

tools/rust-debugger/format-tests/src/format_tests.rs

@@ -57,7 +57,11 @@ fn main() {
     push!(to_check, bigfloat, "-1234.5678");
 
     let managed_buffer: ManagedBuffer<DebugApi> = ManagedBuffer::new_from_bytes(b"hello world");
-    push!(to_check, managed_buffer, "(11) 0x68656c6c6f20776f726c64");
+    push!(
+        to_check,
+        managed_buffer,
+        "\"hello world\" - (11) 0x68656c6c6f20776f726c64"
+    );
 
     let token_identifier: TokenIdentifier<DebugApi> = TokenIdentifier::from("MYTOK-123456");
     push!(to_check, token_identifier, "\"MYTOK-123456\"");
@@ -71,7 +75,7 @@ fn main() {
 
     let managed_byte_array: ManagedByteArray<DebugApi, 4> =
         ManagedByteArray::new_from_bytes(b"test");
-    push!(to_check, managed_byte_array, "(4) 0x74657374");
+    push!(to_check, managed_byte_array, "\"test\" - (4) 0x74657374");
 
     let managed_option_some_token_identifier: ManagedOption<DebugApi, TokenIdentifier<DebugApi>> =
         ManagedOption::some(token_identifier.clone());
@@ -166,7 +170,7 @@ fn main() {
     push!(
         to_check,
         managed_vec_of_managed_buffers,
-        "(3) { [0] = (2) 0x6162, [1] = (4) 0x61626364, [2] = (12) 0x6162636465666768696a6b6c }"
+        "(3) { [0] = \"ab\" - (2) 0x6162, [1] = \"abcd\" - (4) 0x61626364, [2] = \"abcdefghijkl\" - (12) 0x6162636465666768696a6b6c }"
     );
 
     // 6. MultiversX codec - Multi-types

tools/rust-debugger/format-tests/tests/run_format_tests.rs

@@ -6,12 +6,12 @@ fn run_format_tests() {
     let home_dir = home::home_dir().unwrap();
 
     let mut vscode_lldb_plugin_lookup = home_dir.clone();
-    vscode_lldb_plugin_lookup.push(".vscode/extensions/vadimcn.vscode-lldb-1.11.0*");
+    vscode_lldb_plugin_lookup.push(".vscode/extensions/vadimcn.vscode-lldb-1.11.1*");
 
     let vscode_lldb_plugin = glob::glob(vscode_lldb_plugin_lookup.as_os_str().to_str().unwrap())
         .expect("Failed to read glob pattern")
         .next()
-        .expect("No installed vscode-lldb found")
+        .expect("No installed vscode-lldb found. Check for matching version in .vscode/extensions")
         .expect("Glob failed");
     check_path(&vscode_lldb_plugin);
 

tools/rust-debugger/pretty-printers/multiversx_sc_lldb_pretty_printers.py

@@ -1,4 +1,5 @@
 from functools import partial
+import string
 from typing import Callable, Collection, Iterable, List, Tuple, Type
 from lldb import SBValue, SBDebugger
 import lldb
@@ -186,9 +187,18 @@ def ascii_to_string(buffer_iterator: Iterable[int]) -> str:
 
 
 def buffer_as_string(buffer: lldb.value) -> str:
-    buffer_string = ascii_to_string(buffer)
+    buffer_ints = buffer_to_bytes(buffer)
+    buffer_string = ascii_to_string(buffer_ints)
     return f'"{buffer_string}"'
 
+def mixed_representation(buffer: lldb.value) -> str:
+    buffer_hex = format_buffer_hex(buffer)
+    buffer_string = buffer_as_string(buffer)
+    if all(c in string.printable for c in buffer_string):
+        return buffer_string + " - " + buffer_hex
+
+    return buffer_hex
+
 
 def parse_handles_from_buffer_hex(buffer_hex: str) -> List[int]:
     """
@@ -315,7 +325,7 @@ def value_summary(self, value: lldb.value, context: lldb.value, type_info: lldb.
 
 class ManagedBuffer(PlainManagedVecItem, ManagedType):
     def value_summary(self, buffer: lldb.value, context: lldb.value, type_info: lldb.SBType) -> str:
-        return format_buffer_hex(buffer)
+        return mixed_representation(buffer)
 
 
 class BigUint(PlainManagedVecItem, ManagedType):
@@ -342,15 +352,15 @@ def lookup(self, managed_address: lldb.value) -> lldb.value:
         return managed_address.bytes.buffer
 
     def value_summary(self, buffer: lldb.value, context: lldb.value, type_info: lldb.SBType) -> str:
-        return format_buffer_hex(buffer)
+        return mixed_representation(buffer)
 
 
 class ManagedByteArray(PlainManagedVecItem, ManagedType):
     def lookup(self, managed_byte_array: lldb.value) -> lldb.value:
         return managed_byte_array.buffer
 
     def value_summary(self, buffer: lldb.value, context: lldb.value, type_info: lldb.SBType) -> str:
-        return format_buffer_hex(buffer)
+        return mixed_representation(buffer)
 
 
 class ManagedOption(PlainManagedVecItem, ManagedType):