[misc] add nanoem's natvis and its description (#95)

hkrn · Dec 31, 2021 · 27efc3a · 27efc3a
1 parent 98a3108
commit 27efc3a
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 0 deletions.
diff --git a/docs/architecture.rst b/docs/architecture.rst
@@ -563,6 +563,19 @@ nanoem の GUI バックエンドとして利用しているライブラリで
 主にゲーム開発における GUI ライブラリとして利用されますが、nanoem では直接ユーザが利用する GUI ライブラリとして利用しています。
 初期から利用しておりその時はデフォルトのルックフィールを利用していましたが、 `nuklear <https://github.com/vurtun/nuklear>`_ を一時期に採用してた関係から nuklear の見た目と合わせる形でルックフィールを変更しています。
 
+デバッグ表示の可視化
+==========================================
+
+Visual Studio を利用している場合は以下に natvis のファイルがあるので、それらを ``%UserProfile%Visual Studio XXXX\Visualizers`` に配置することでデバッグ時に表示を可視化できます。
+
+* dependencies/bx/scripts/bx.natvis
+* dependencies/bx/scripts/tinystl.natvis
+* dependencies/glm/util/glm.natvis
+* dependencies/imgui/misc/debuggers/imgui.natvis
+* scripts/nanoem.nativs
+
+また QtCreator を利用している場合は ``scripts/qtcreator/helper.py`` があるので https://doc.qt.io/qtcreator/creator-debugging-helpers.html の ``Extra Debugging Helpers`` に該当パスを指定することによりデバッグ時に表示を可視化できます。
+
 .. _2712B38B-9A84-43A2-B903-FB390383054C:
 
 よろずのおはなし

diff --git a/scripts/nanoem.natvis b/scripts/nanoem.natvis
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
+    <!-- nanoem::String -->
+    <Type Name="tinystl::stringT&lt;nanoem::TinySTLAllocator&gt;">
+        <DisplayString>{m_first,[m_last - m_first]s8}</DisplayString>
+        <StringView>m_first,[m_last - m_first]s8</StringView>
+        <Expand>
+            <Item Name="[size]">m_last - m_first</Item>
+            <Item Name="[capacity]">m_capacity - m_first</Item>
+            <ArrayItems>
+                <Size>m_last - m_first</Size>
+                <ValuePointer>m_first</ValuePointer>
+            </ArrayItems>
+        </Expand>
+    </Type>
+    <!-- nanoem::MutableString (excludes null terminator) -->
+    <Type Name="tinystl::vector&lt;char,nanoem::TinySTLAllocator&gt;">
+        <DisplayString>{m_buffer.first,[m_buffer.last - m_buffer.first - 1]s8}</DisplayString>
+        <StringView>m_buffer.first,[m_buffer.last - m_buffer.first - 1]s8</StringView>
+        <Expand>
+            <Item Name="[size]">m_buffer.last - m_buffer.first - 1</Item>
+            <ArrayItems>
+                <Size>m_buffer.last - m_buffer.first - 1</Size>
+                <ValuePointer>m_buffer.first</ValuePointer>
+            </ArrayItems>
+        </Expand>
+    </Type>
+    <!-- nanoem::MutableWideString (excludes null terminator) -->
+    <Type Name="tinystl::vector&lt;wchar_t,nanoem::TinySTLAllocator&gt;">
+        <DisplayString>{m_buffer.first,[m_buffer.last - m_buffer.first  -1]su}</DisplayString>
+        <StringView>m_buffer.first,[m_buffer.last - m_buffer.first - 1]su</StringView>
+        <Expand>
+            <Item Name="[size]">m_buffer.last - m_buffer.first - 1</Item>
+            <ArrayItems>
+                <Size>m_buffer.last - m_buffer.first - 1</Size>
+                <ValuePointer>m_buffer.first</ValuePointer>
+            </ArrayItems>
+        </Expand>
+    </Type>
+</AutoVisualizer>