ENH: Add LLDB pretty printers for a few SIMPLNX classes. #1178
Conversation
* More to come later
There is a bit of setup that one must do in order to get LLDB to use these pretty
printers. Namely create a file called `.lldbinit` at the top level of your home
directory and put the following code in it:
```
command script import /Users/${USER}/Workspace1/simplnx/scripts/lldb_pretty_printers/data_path_pretty_printer.py
command script import /Users/${USER}/Workspace1/simplnx/scripts/lldb_pretty_printers/nx_core_array_pretty_printer.py
```
Where you will need to adjust the path to the actual python files based on how you have your environment setup.
Signed-off-by: Michael Jackson <[email protected]>
| """ | ||
|
|
||
| # 1) Retrieve the m_Array child. | ||
| std_array_elements = valobj.GetChildMemberWithName("m_Array").GetChildMemberWithName("__elems_") |
There was a problem hiding this comment.
This uses the libc++ implementation which means it won't work with libstdc++ which is typical when using clang and lldb on linux.
| # Use LLDB's synthetic children for std::vector to retrieve each element. | ||
| count = path_valobj.GetNumChildren() | ||
| elements = [] | ||
| for i in range(count): |
There was a problem hiding this comment.
I looked at the documentation and fortunately lldb.SBValue has __iter__ so you can do for element in path_valobj.
| type summary add -x 'nx::core::Array<.*>' -F nx_core_array_pretty_printer.array_summary | ||
| """ | ||
| debugger.HandleCommand( | ||
| 'type summary add -F nx_core_array_pretty_printer.array_summary "nx::core::Array<*,*>"' |
There was a problem hiding this comment.
| 'type summary add -F nx_core_array_pretty_printer.array_summary "nx::core::Array<*,*>"' | |
| 'type summary add -F nx_core_array_pretty_printer.array_summary -x "nx::core::Array<.*,.*>"' |
The -x is what makes the string be interpreted as a regex so it's needed here but not on the others.
| We'll display the contents of m_Path (std::vector<std::string>) | ||
| as a list of unquoted string values. | ||
| """ | ||
| path_valobj = valobj.GetChildMemberWithName('m_Path') |
There was a problem hiding this comment.
We might consider a different approach since m_Path is a private variable and an implementation detail so if it changes then this breaks. It is possible to call expressions in lldb like so: valobj.EvaluateExpression('toString()'). I think it's worth looking into at least.
There is a bit of setup that one must do in order to get LLDB to use these pretty
printers. Namely create a file called
.lldbinitat the top level of your homedirectory and put the following code in it:
Where you will need to adjust the path to the actual python files based on how you have your environment setup.