Add ImGui

thirdparty/imgui-1.92.5/misc/debuggers/README.txt

@@ -0,0 +1,21 @@
+
+HELPER FILES FOR POPULAR DEBUGGERS
+
+imgui.gdb
+    GDB: disable stepping into trivial functions.
+    (read comments inside file for details)
+
+imgui.natstepfilter
+    Visual Studio Debugger: disable stepping into trivial functions.
+    (read comments inside file for details)
+
+imgui.natvis
+    Visual Studio Debugger: describe Dear ImGui types for better display.
+    With this, types like ImVector<> will be displayed nicely in the debugger.
+    (read comments inside file for details)
+
+imgui_lldb.py
+    LLDB-based debuggers (*): synthetic children provider and summaries for Dear ImGui types.
+    With this, types like ImVector<> will be displayed nicely in the debugger.
+    (read comments inside file for details)
+    (*) Xcode, Android Studio, may be used from VS Code, C++Builder, CLion, Eclipse etc.

thirdparty/imgui-1.92.5/misc/debuggers/imgui.gdb

@@ -0,0 +1,12 @@
+# GDB configuration to aid debugging experience
+
+# To enable these customizations edit $HOME/.gdbinit (or ./.gdbinit if local gdbinit is enabled) and add:
+#   add-auto-load-safe-path /path/to/imgui.gdb
+#   source /path/to/imgui.gdb
+#
+# More Information at:
+#   * https://sourceware.org/gdb/current/onlinedocs/gdb/gdbinit-man.html
+#   * https://sourceware.org/gdb/current/onlinedocs/gdb/Init-File-in-the-Current-Directory.html#Init-File-in-the-Current-Directory
+
+# Disable stepping into trivial functions
+skip -rfunction Im(Vec2|Vec4|Strv|Vector|Span)::.+

thirdparty/imgui-1.92.5/misc/debuggers/imgui.natstepfilter

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+.natstepfilter file for Visual Studio debugger.
+Purpose: instruct debugger to skip some functions when using StepInto (F11)
+
+Since Visual Studio 2022 version 17.6 Preview 2 (currently available as a "Preview" build on March 14, 2023)
+It is possible to add the .natstepfilter file to your project file and it will automatically be used.
+(https://developercommunity.visualstudio.com/t/allow-natstepfilter-and-natjmc-to-be-included-as-p/561718)
+
+For older Visual Studio version prior to 2022 17.6 Preview 2:
+* copy in %USERPROFILE%\Documents\Visual Studio XXXX\Visualizers (current user)
+* or copy in %VsInstallDirectory%\Common7\Packages\Debugger\Visualizers (all users)
+If you have multiple VS version installed, the version that matters is the one you are using the IDE/debugger
+of (not the compiling toolset). This is supported since Visual Studio 2012.
+
+More information at: https://docs.microsoft.com/en-us/visualstudio/debugger/just-my-code?view=vs-2019#BKMK_C___Just_My_Code
+-->
+
+<StepFilter xmlns="http://schemas.microsoft.com/vstudio/debugger/natstepfilter/2010">
+
+    <!-- Disable stepping into trivial functions -->
+    <Function>
+        <Name>(ImVec2|ImVec4|ImStrv)::.+</Name>
+        <Action>NoStepInto</Action>
+    </Function>
+    <Function>
+        <Name>(ImVector|ImSpan).*::operator.+</Name>
+        <Action>NoStepInto</Action>
+    </Function>
+
+</StepFilter>

thirdparty/imgui-1.92.5/misc/debuggers/imgui.natvis

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+.natvis file for Visual Studio debugger.
+Purpose: provide nicer views on data types used by Dear ImGui.
+
+To enable:
+* include file in your VS project (most recommended: not intrusive and always kept up to date!)
+* or copy in %USERPROFILE%\Documents\Visual Studio XXXX\Visualizers (current user)
+* or copy in %VsInstallDirectory%\Common7\Packages\Debugger\Visualizers (all users)
+
+More information at: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019
+-->
+
+<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
+
+<Type Name="ImVector&lt;*&gt;">
+  <DisplayString>{{Size={Size} Capacity={Capacity}}}</DisplayString>
+  <Expand>
+    <ArrayItems>
+      <Size>Size</Size>
+      <ValuePointer>Data</ValuePointer>
+    </ArrayItems>
+  </Expand>
+</Type>
+
+<Type Name="ImSpan&lt;*&gt;">
+  <DisplayString>{{Size={DataEnd-Data} }}</DisplayString>
+  <Expand>
+    <ArrayItems>
+      <Size>DataEnd-Data</Size>
+      <ValuePointer>Data</ValuePointer>
+    </ArrayItems>
+  </Expand>
+</Type>
+
+<Type Name="ImVec2">
+  <DisplayString>{{x={x,g} y={y,g}}}</DisplayString>
+</Type>
+
+<Type Name="ImVec4">
+  <DisplayString>{{x={x,g} y={y,g} z={z,g} w={w,g}}}</DisplayString>
+</Type>
+
+<Type Name="ImRect">
+  <DisplayString>{{Min=({Min.x,g} {Min.y,g}) Max=({Max.x,g} {Max.y,g}) Size=({Max.x-Min.x,g} {Max.y-Min.y,g})}}</DisplayString>
+  <Expand>
+    <Item Name="Min">Min</Item>
+    <Item Name="Max">Max</Item>
+    <Item Name="[Width]">Max.x - Min.x</Item>
+    <Item Name="[Height]">Max.y - Min.y</Item>
+  </Expand>
+</Type>
+
+<Type Name="ImGuiWindow">
+  <DisplayString>{{Name {Name,s} Active {(Active||WasActive)?1:0,d} Child {(Flags &amp; 0x01000000)?1:0,d} Popup {(Flags &amp; 0x04000000)?1:0,d} Hidden {(Hidden)?1:0,d}}</DisplayString>
+</Type>
+
+</AutoVisualizer>

thirdparty/imgui-1.92.5/misc/debuggers/imgui_lldb.py

@@ -0,0 +1,189 @@
+# 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:
+# - https://lldb.llvm.org/use/variable.html#summary-strings
+# - https://lldb.llvm.org/use/variable.html#synthetic-children
+# - https://lldb.llvm.org/python_reference/lldb-module.html
+#
+# To use it in a debug session:
+# > (lldb) command script import <path-to-this-file>
+#
+# Alternatively you may include the above command in your ~/.lldbinit file to have the formatters
+# available in all future sessions
+
+import lldb
+
+class ArraySynthBase(object):
+	"""
+	Helper baseclass aimed to reduce the boilerplate needed for "array-like" containers
+	"""
+
+	def __init__(self, valobj, internal_dict):
+		self.valobj = valobj
+
+	def bind_to(self, pointer, size):
+		array_p = pointer.GetType().GetPointeeType().GetArrayType(size).GetPointerType()
+		self.array = pointer.Cast(array_p).Dereference()
+
+	def update(self):
+		self.array = self.valobj
+
+	def num_children(self, max_children):
+		return self.array.GetNumChildren(max_children)
+
+	def get_child_index(self, name):
+		return self.array.GetIndexOfChildWithName(name)
+
+	def get_child_at_index(self, index):
+		return self.array.GetChildAtIndex(index)
+
+	def has_children(self):
+		return self.array.MightHaveChildren()
+
+	def get_value(self):
+		return self.array
+
+class ImVectorSynth(ArraySynthBase):
+	def update(self):
+		self.size = self.valobj.GetChildMemberWithName("Size").GetValueAsUnsigned()
+		self.capacity = self.valobj.GetChildMemberWithName("Capacity").GetValueAsUnsigned()
+
+		data = self.valobj.GetChildMemberWithName("Data")
+		
+		self.bind_to(data, self.size)
+
+	def get_summary(self):
+		return f"Size={self.size} Capacity={self.capacity}"
+
+class ImSpanSynth(ArraySynthBase):
+	def update(self):
+		data = self.valobj.GetChildMemberWithName("Data")
+		end = self.valobj.GetChildMemberWithName("DataEnd")
+		
+		element_size = data.GetType().GetPointeeType().GetByteSize()
+		array_size = end.GetValueAsUnsigned() - data.GetValueAsUnsigned()
+
+		self.size = int(array_size / element_size)
+
+		self.bind_to(data, self.size)
+
+	def get_summary(self):
+		return f"Size={self.size}"
+
+class ImRectSummary(object):
+	def __init__(self, valobj, internal_dict):
+		self.valobj = valobj
+
+	def update(self):
+		pass
+
+	def get_summary(self):
+		min = self.valobj.GetChildMemberWithName("Min")
+		max = self.valobj.GetChildMemberWithName("Max")
+
+		minX = float(min.GetChildMemberWithName("x").GetValue())
+		minY = float(min.GetChildMemberWithName("y").GetValue())
+
+		maxX = float(max.GetChildMemberWithName("x").GetValue())
+		maxY = float(max.GetChildMemberWithName("y").GetValue())
+
+		return f"Min=({minX}, {minY}) Max=({maxX}, {maxY}) Size=({maxX - minX}, {maxY - minY})"
+
+def get_active_enum_flags(valobj):
+	flag_set = set()
+
+	enum_name = valobj.GetType().GetName() + "_"
+	enum_type = valobj.GetTarget().FindFirstType(enum_name)
+
+	if not enum_type.IsValid():
+		return flag_set
+
+	enum_members = enum_type.GetEnumMembers()
+	value = valobj.GetValueAsUnsigned()
+
+	for i in range(0, enum_members.GetSize()):
+		member = enum_members.GetTypeEnumMemberAtIndex(i)
+
+		if value & member.GetValueAsUnsigned():
+			flag_set.add(member.GetName().removeprefix(enum_name))
+
+	return flag_set
+
+class ImGuiWindowSummary(object):
+	def __init__(self, valobj, internal_dict):
+		self.valobj = valobj
+
+	def update(self):
+		pass
+
+	def get_summary(self):
+		name = self.valobj.GetChildMemberWithName("Name").GetSummary()
+
+		active = self.valobj.GetChildMemberWithName("Active").GetValueAsUnsigned() != 0
+		was_active = self.valobj.GetChildMemberWithName("WasActive").GetValueAsUnsigned() != 0
+		hidden = self.valobj.GetChildMemberWithName("Hidden") != 0
+
+		flags = get_active_enum_flags(self.valobj.GetChildMemberWithName("Flags"))
+
+		active = 1 if  active or was_active else 0
+		child = 1 if "ChildWindow" in flags else 0
+		popup = 1 if "Popup" in flags else 0
+		hidden = 1 if hidden else 0
+
+		return f"Name {name} Active {active} Child {child} Popup {popup} Hidden {hidden}"
+
+
+def __lldb_init_module(debugger, internal_dict):
+	"""
+	This function will be automatically called by LLDB when the module is loaded, here
+	we register the various synthetics/summaries we have build before
+	"""
+
+	category_name = "imgui"
+	category = debugger.GetCategory(category_name)
+
+	# Make sure we don't accidentally keep accumulating languages or override the user's
+	# category enablement in Xcode, where lldb-rpc-server loads this file once for eac
+	# debugging session
+	if not category.IsValid():
+		category = debugger.CreateCategory(category_name)
+		category.AddLanguage(lldb.eLanguageTypeC_plus_plus)
+		category.SetEnabled(True)
+
+	def add_summary(typename, impl):
+		summary = None
+
+		if isinstance(impl, str):
+			summary = lldb.SBTypeSummary.CreateWithSummaryString(impl)
+			summary.SetOptions(lldb.eTypeOptionCascade)
+		else:
+			# Unfortunately programmatic summary string generation is an entirely different codepath
+			# in LLDB. Register a convenient trampoline function which makes it look like it's part
+			# of the SyntheticChildrenProvider contract
+			summary = lldb.SBTypeSummary.CreateWithScriptCode(f'''
+				synth = {impl.__module__}.{impl.__qualname__}(valobj.GetNonSyntheticValue(), internal_dict)
+				synth.update()
+
+				return synth.get_summary()
+			''')
+			summary.SetOptions(lldb.eTypeOptionCascade | lldb.eTypeOptionFrontEndWantsDereference)
+
+		category.AddTypeSummary(lldb.SBTypeNameSpecifier(typename, True), summary)
+
+	def add_synthetic(typename, impl):
+		add_summary(typename, impl)
+
+		synthetic = lldb.SBTypeSynthetic.CreateWithClassName(f"{impl.__module__}.{impl.__qualname__}")
+		synthetic.SetOptions(lldb.eTypeOptionCascade | lldb.eTypeOptionFrontEndWantsDereference)
+
+		category.AddTypeSynthetic(lldb.SBTypeNameSpecifier(typename, True), synthetic)
+
+	add_synthetic("^ImVector<.+>$", ImVectorSynth)
+	add_synthetic("^ImSpan<.+>$", ImSpanSynth)
+
+	add_summary("^ImVec2$", "x=${var.x} y=${var.y}")
+	add_summary("^ImVec4$", "x=${var.x} y=${var.y} z=${var.z} w=${var.w}")
+	add_summary("^ImRect$", ImRectSummary)
+	add_summary("^ImGuiWindow$", ImGuiWindowSummary)