Browse Source

Added type formatters for the LLDB debuggers (e.g. Xcode, Android Studio) (#8950)

ocornut 3 tuần trước cách đây
mục cha
commit
46e6382b69

+ 3 - 0
docs/CHANGELOG.txt

@@ -45,6 +45,9 @@ Other Changes:
 
 
 - IO: added ImGuiPlatformIO::ClearPlatformHandlers(), ClearRendererHandlers()
 - IO: added ImGuiPlatformIO::ClearPlatformHandlers(), ClearRendererHandlers()
   helpers to null all handlers. (#8945, #2769)
   helpers to null all handlers. (#8945, #2769)
+- Misc: Debuggers: added type formatters for the LLDB debuggers (e.g. Xcode,
+  Android Studio & more) to provide nicer display for ImVec2, ImVec4, ImVector etc.
+  See misc/debuggers/ for details. (#8950) [@mentlerd]
 - Backends: all backends call ImGuiPlatformIO::ClearPlatformHandlers() and
 - Backends: all backends call ImGuiPlatformIO::ClearPlatformHandlers() and
   ClearRendererHandlers() on shutdown, so as not to leave function pointers
   ClearRendererHandlers() on shutdown, so as not to leave function pointers
   which may be dangling when using backend in e.g. DLL. (#8945, #2769)
   which may be dangling when using backend in e.g. DLL. (#8945, #2769)

+ 2 - 2
misc/README.txt

@@ -4,8 +4,8 @@ misc/cpp/
   This is also an example of how you may wrap your own similar types.
   This is also an example of how you may wrap your own similar types.
 
 
 misc/debuggers/
 misc/debuggers/
-  Helper files for popular debuggers.
-  With the .natvis file, types like ImVector<> will be displayed nicely in Visual Studio debugger.
+  Helper files for popular debuggers (Visual Studio, GDB, LLDB).
+  e.g. With the .natvis file, types like ImVector<> will be displayed nicely in Visual Studio debugger.
 
 
 misc/fonts/
 misc/fonts/
   Fonts loading/merging instructions (e.g. How to handle glyph ranges, how to merge icons fonts).
   Fonts loading/merging instructions (e.g. How to handle glyph ranges, how to merge icons fonts).

+ 2 - 1
misc/debuggers/README.txt

@@ -15,6 +15,7 @@ imgui.natvis
     (read comments inside file for details)
     (read comments inside file for details)
 
 
 imgui_lldb.py
 imgui_lldb.py
-    LLDB: synthetic children provider and summaries for Dear ImGui types.
+    LLDB-based debuggers (*): synthetic children provider and summaries for Dear ImGui types.
     With this, types like ImVector<> will be displayed nicely in the debugger.
     With this, types like ImVector<> will be displayed nicely in the debugger.
     (read comments inside file for details)
     (read comments inside file for details)
+    (*) Xcode, Android Studio, may be used from VS Code, C++Builder, CLion, Eclipse etc.

+ 3 - 1
misc/debuggers/imgui_lldb.py

@@ -1,4 +1,6 @@
-# This file implements synthetic children providers and summaries for various ImGui types for LLDB. 
+# This file implements synthetic children providers and summaries for various Dear ImGui types for LLDB.
+# LLDB is used by Xcode, Android Studio, and may be used from VS Code, C++Builder, CLion, Eclipse etc.
+
 #
 #
 # Useful links/documentation related to the feature:
 # Useful links/documentation related to the feature:
 # - https://lldb.llvm.org/use/variable.html#summary-strings
 # - https://lldb.llvm.org/use/variable.html#summary-strings