Added loads more annotated things - mainly focused on templates that result in globals being created

Author: Numynum

src/Frame.php

@@ -4,17 +4,21 @@
 
 namespace App;
 
+use RuntimeException;
 use SimpleXMLElement;
 
 class Frame
 {
+    private readonly ?self $originalParent;
+
     public function __construct(
         private readonly string $name,
         private readonly string $type,
         private readonly SimpleXMLElement $xmlElement,
-        private readonly ?self $parent = null,
+        private ?self $parent = null,
         private array $children = [],
     ) {
+        $this->originalParent = $parent;
     }
 
     public function isRootNode(): bool
@@ -57,6 +61,19 @@ public function getParent(): ?self
         return $this->parent;
     }
 
+    public function withParent(self $parent): self
+    {
+        $clone = clone $this;
+        $clone->parent = $parent;
+
+        return $clone;
+    }
+
+    public function getOriginalParent(): ?self
+    {
+        return $this->originalParent;
+    }
+
     public function getParentKey(): ?string
     {
         $parentKey = (string) $this->xmlElement->attributes()['parentKey'] ?? '';
@@ -102,7 +119,7 @@ public function getInherits(): array
     }
 
     /**
-     * @return array<string, string> [key => formattedValue] value is formatted to be written directly into lua
+     * @return array<string, array{1: string, 2: string}> [key => [formattedValue, type]] value is formatted to be written directly into lua
      */
     public function getKeyValues(): array
     {
@@ -111,18 +128,31 @@ public function getKeyValues(): array
         }
         $keyValues = [];
         foreach ($this->xmlElement->KeyValues as $child) {
-            $key = (string) $child->attributes()['key'] ?? '';
-            $value = (string) $child->attributes()['value'] ?? '';
-            $type = (string) $child->attributes()['type'] ?? 'string';
+            if (!isset($child->KeyValue)) {
+                continue;
+            }
+            $keyValue = $child->KeyValue;
+            $key = (string) $keyValue->attributes()['key'] ?? '';
+            $value = (string) $keyValue->attributes()['value'] ?? '';
+            $type = (string) $keyValue->attributes()['type'] ?: 'string';
             if ($key === '') {
                 continue;
             }
             $value = match($type) {
-                'number', 'global' => $value,
-                'boolean' => $value === 'true',
-                default => json_encode($value), // json_encodes adds quotes to the string
+                'number', 'global', 'boolean' => $value,
+                'nil' => 'nil',
+                'string' => json_encode($value), // json_encodes adds quotes to the string
+                default => throw new RuntimeException("Unknown type: $type"),
+            };
+            $type = match($type) {
+                'number' => 'number',
+                'boolean' => 'boolean',
+                'global' => 'any',
+                'nil' => 'nil',
+                'string' => 'string',
+                default => throw new RuntimeException("Unknown type: $type"),
             };
-            $keyValues[$key] = $value;
+            $keyValues[$key] = [$value, $type];
         }
 
         return $keyValues;

src/XmlFileParser.php

@@ -170,37 +170,72 @@ private function childHasInterestingData(Frame $child): bool
             || !empty($child->getChildren());
     }
 
-    private function writeFrame(Frame $frame, ?string $linkPrefix): string
+    private function writeFrame(Frame $frame, ?string $linkPrefix, ?string $typeOverride = null): string
     {
         $data = '';
+        $globalChildrenWithParentKey = [];
         foreach ($frame->getChildren() as $child) {
             if ($this->childHasInterestingData($child)) {
                 $data .= $this->writeFrame($child, $linkPrefix);
+                if ($child->getName() && $child->getParentKey()) {
+                    $globalChildrenWithParentKey[$child->getParentKey()] = $child->getName();
+                }
+            }
+        }
+        $inheritedKeyValues = [];
+        foreach ($frame->getInherits() as $templateName) {
+            $template = $this->templateRegistry->get($templateName);
+            if (!$template) {
+                continue;
+            }
+            foreach ($template->getKeyValues() as $key => $value) {
+                $inheritedKeyValues[$key] = $value;
+            }
+            foreach ($template->getChildren() as $child) {
+                $clone = $child->withParent($frame);
+                if (!empty($clone->getName())) { // will create a global
+                    $data .= $this->writeFrame(
+                        $clone,
+                        $linkPrefix,
+                        $this->childHasInterestingData($child) ? $child->getClassName() : $child->getType(), // this must be $child rather than $clone
+                    );
+                    if($clone->getParentKey()) {
+                        $inheritedKeyValues[$clone->getParentKey()] = [$clone->getName()];
+                    }
+                }
             }
         }
 
         if ($linkPrefix) {
             $data .= "--- [Source]($linkPrefix#L" . $frame->getLineNumber() . ")\n";
         }
         if ($frame->getParent()) {
-            $data .= '--- child of ' . $frame->getParent()->getName() . "\n";
+            $data .= '--- child of ' . $frame->getParent()->getName();
+            if ($frame->getOriginalParent() && $frame->getOriginalParent() !== $frame->getParent()) {
+                $data .= ' (created in template ' . $frame->getOriginalParent()->getName() . ')';
+            }
+            $data .= "\n";
         }
         if ($frame instanceof Intrinsic) {
             $data .= "--- Intrinsic\n";
         } elseif ($frame instanceof Template) {
             $data .= "--- Template\n";
         }
-        $data .= '--- @class ' . $frame->getClassName() . ' : ' . $frame->getType();
-        foreach ($frame->getInherits() as $inherit) {
-            $data .= ', ' . $inherit;
-        }
-        foreach ($frame->getMixins() as $mixin) {
-            $data .= ', ' . $mixin;
+        if ($typeOverride) {
+            $data .= '--- @type ' . $typeOverride;
+        } else {
+            $data .= '--- @class ' . $frame->getClassName() . ' : ' . $frame->getType();
+            foreach ($frame->getInherits() as $inherit) {
+                $data .= ', ' . $inherit;
+            }
+            foreach ($frame->getMixins() as $mixin) {
+                $data .= ', ' . $mixin;
+            }
         }
         $data .= "\n";
 
         foreach ($frame->getKeyValues() as $key => $value) {
-            $data .= '--- @field ' . $key . ' ' . $value . "\n";
+            $data .= '--- @field ' . $key . ' ' . $value[1] . ' # ' . $value[0] . "\n";
         }
         foreach ($frame->getChildren() as $child) {
             if ($child->getParentKey()) {
@@ -213,9 +248,15 @@ private function writeFrame(Frame $frame, ?string $linkPrefix): string
         }
         if ($frame->getName() && $frame->getRootNode()::class === Frame::class) {
             $data .= $frame->getName() . " = {}\n";
-            foreach ($frame->getKeyValues() as $key => $value) {
+            foreach ($globalChildrenWithParentKey as $key => $value) {
                 $data .= $frame->getName() . '["' . $key . '"] = ' . $value . "\n";
             }
+            foreach ($frame->getKeyValues() as $key => $value) {
+                $data .= $frame->getName() . '["' . $key . '"] = ' . $value[0] . "\n";
+            }
+            foreach ($inheritedKeyValues as $key => $value) {
+                $data .= $frame->getName() . '["' . $key . '"] = ' . $value[0] . " -- inherited\n";
+            }
         }
 
         return $data . "\n";