Add uncovered structs to imgui_structs.md

PGZXB · Jul 31, 2024 · 60d53d2 · 60d53d2
1 parent 5ff5b50
commit 60d53d2
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/docs/imgui_structs.md b/docs/imgui_structs.md
@@ -3356,4 +3356,20 @@
 #### functions:
 
 ## Uncovered Structs
-
+These structs don't have a wrapper class; instead, they are typedef'd as `Unit`, which allows their pointers (`CPointer<Struct>`) to be used as function parameters/return but prevents direct access to their members.
+
+* `ImFontGlyph`
+* `ImGuiContext`
+* `ImGuiDockNode`
+* `ImGuiDockNodeSettings`
+* `ImGuiDockRequest`
+* `ImGuiInputEvent`
+* `ImGuiInputTextDeactivateData`
+* `ImGuiStackLevelInfo`
+* `ImGuiStoragePair`
+* `ImGuiStyleMod`
+* `ImGuiTable`
+* `ImGuiTableColumn`
+* `ImGuiTableColumnSettings`
+* `ImGuiTableColumnsSettings`
+* `ImGuiWindow`
diff --git a/generator/src/main.cj b/generator/src/main.cj
@@ -127,6 +127,7 @@ main(args: Array<String>): Int64 {
             case StructType(name) => if (!definedStructNames.contains(name)) {
                 undefStructTypedefs.append(TypeDef(alias, "void"))
                 typeAlias.put(alias, UnitType)
+                apiInfo.addUncoveredStruct(name)
             }
             case _ => continue
         }

diff --git a/generator/src/utils.cj b/generator/src/utils.cj
@@ -811,8 +811,8 @@ class APIInfo {
         }
     }
 
-    func addUncoveredStruct(fn: String) {
-        uncoveredStructs.append(fn)
+    func addUncoveredStruct(structName: String) {
+        uncoveredStructs.append(structName)
     }
 
     func generateDocumentForGlobalFunctions<T>(os: StringWriter<T>) where T <: OutputStream {
@@ -926,6 +926,10 @@ class APIInfo {
         }
         os.writeln()
         os.writeln("## Uncovered Structs")
+        os.writeln(
+            "These structs don't have a wrapper class; instead, they are typedef'd as `Unit`, " +
+            "which allows their pointers (`CPointer<Struct>`) to be used as function parameters/return " +
+            "but prevents direct access to their members.")
         os.writeln()
         for (s in uncoveredStructs) {
             os.writeln("* `${s}`")