Parse toc files to implement support for flavor filters (such as AllowLoadGameMode etc) instead of parsing all lua and xml files

Numynum · Numynum · commit 0889275dffd4 · 2025-04-02T20:00:34.000+02:00
diff --git a/.github/workflows/beta.yml b/.github/workflows/beta.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: beta
+      FLAVOR: mainline
diff --git a/.github/workflows/classic.yml b/.github/workflows/classic.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic
+      FLAVOR: cata
diff --git a/.github/workflows/classic_era.yml b/.github/workflows/classic_era.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era
+      FLAVOR: vanilla
diff --git a/.github/workflows/classic_era_ptr.yml b/.github/workflows/classic_era_ptr.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era_ptr
+      FLAVOR: vanilla
diff --git a/.github/workflows/classic_ptr.yml b/.github/workflows/classic_ptr.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_ptr
+      FLAVOR: cata
diff --git a/.github/workflows/force_update_all.yml b/.github/workflows/force_update_all.yml
@@ -9,45 +9,53 @@ jobs:
     with:
       BRANCH: live
       FORCE_UPDATE: true
+      FLAVOR: mainline
 
   ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr
       FORCE_UPDATE: true
+      FLAVOR: mainline
 
   ptr2:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr2
       FORCE_UPDATE: true
+      FLAVOR: mainline
 
   beta:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: beta
       FORCE_UPDATE: true
+      FLAVOR: mainline
 
   classic:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic
       FORCE_UPDATE: true
+      FLAVOR: cata
 
   classic_ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_ptr
       FORCE_UPDATE: true
+      FLAVOR: cata
 
   classic_era:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era
       FORCE_UPDATE: true
+      FLAVOR: vanilla
 
   classic_era_ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era_ptr
       FORCE_UPDATE: true
+      FLAVOR: vanilla
diff --git a/.github/workflows/live.yml b/.github/workflows/live.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: live
+      FLAVOR: mainline
diff --git a/.github/workflows/ptr.yml b/.github/workflows/ptr.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr
+      FLAVOR: mainline
diff --git a/.github/workflows/ptr2.yml b/.github/workflows/ptr2.yml
@@ -10,3 +10,4 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr2
+      FLAVOR: mainline
diff --git a/.github/workflows/template.yml b/.github/workflows/template.yml
@@ -1,25 +1,42 @@
 name: template
 
 on:
-  workflow_call:
+  workflow_dispatch:
     inputs:
       BRANCH:
         description: 'Branch to run the workflow on'
         required: true
         default: 'live'
         type: string
+      FLAVOR:
+        description: 'Flavor to filter the input for'
+        required: true
+        default: 'mainline'
+        type: choice
+        options:
+          - mainline
+          - mists
+          - cata
+          - wrath
+          - tbc
+          - vanilla
       FORCE_UPDATE:
         description: 'Force update the branch'
         required: false
         default: false
         type: boolean
-  workflow_dispatch:
+  workflow_call:
     inputs:
       BRANCH:
         description: 'Branch to run the workflow on'
         required: true
         default: 'live'
         type: string
+      FLAVOR:
+        description: 'Flavor to filter the input for'
+        required: true
+        default: 'mainline'
+        type: string
       FORCE_UPDATE:
         description: 'Force update the branch'
         required: false
@@ -112,11 +129,12 @@ jobs:
         run: |
           set -ex
           branch=${{ inputs.BRANCH }}
+          flavor=${{ inputs.FLAVOR }}
           cd ./.wow-ui-source
           remote_commit_hash=$(git rev-parse HEAD)
           message="Synced to commit ${remote_commit_hash}"
           cd ..
-          bin/annotate --inputDir=./.wow-ui-source/Interface --outputDir=./.annotations_temp/Annotations --linkPrefix="https://github.com/Gethe/wow-ui-source/blob/${branch}/Interface"
+          bin/annotate ${flavor} --inputDir=./.wow-ui-source/Interface --outputDir=./.annotations_temp/Annotations --linkPrefix="https://github.com/Gethe/wow-ui-source/blob/${branch}/Interface"
           cd ./.annotations_temp
           git config user.name "GitHub Actions"
           git config user.email noreply@github.com
diff --git a/bin/annotate b/bin/annotate
@@ -2,10 +2,13 @@
 <?php
 declare(strict_types=1);
 
+use App\FlavorEnum;
 use App\LuaFileParser;
 use App\Registry;
+use App\TocFileParser;
 use App\XmlFileParser;
 use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\ConsoleOutput;
@@ -23,15 +26,77 @@ $inputDefinition->addOption(
 $inputDefinition->addOption(
     new InputOption('linkPrefix', 'l', InputOption::VALUE_REQUIRED, 'Prefix for links in the output'),
 );
+$inputDefinition->addArgument(
+        // it's actually required, but --help doesn't work with required arguments atm
+    new InputArgument('flavor', InputArgument::OPTIONAL, 'Flavor to filter toc files on. E.g. "mainline", "cata", "vanilla"'),
+);
+$inputDefinition->addOption(
+    new InputOption('help', 'h', InputOption::VALUE_NONE, 'Display this help message'),
+);
 $input = new ArgvInput(definition: $inputDefinition);
 $output = new ConsoleOutput();
 $io = new SymfonyStyle($input, $output);
 
+if ($input->getOption('help')) {
+    // should probably just bite the bullet and use the Symfony Console component properly :)
+    $io->writeln('Usage: annotate [options] <flavor>');
+    $io->writeln('');
+    $io->writeln('Options:');
+    foreach ($inputDefinition->getOptions() as $option) {
+        $message = '  ';
+        if ($option->getShortcut()) {
+            $message .= sprintf('-%s, ', $option->getShortcut());
+        }
+        $message .= sprintf('--%s', $option->getName());
+        if ($option->acceptValue()) {
+            $message .= '=VALUE';
+        }
+        $message .= sprintf('  %s', $option->getDescription());
+        if ($option->acceptValue()) {
+            $defaultValue = $option->getDefault();
+            if (null !== $defaultValue && !is_array($defaultValue)) {
+                $message .= sprintf(' (default: %s)', $defaultValue);
+            }
+        }
+        $io->writeln($message);
+    }
+    $io->writeln('');
+    $io->writeln('Arguments:');
+    foreach ($inputDefinition->getArguments() as $argument) {
+        $message = '  ';
+        if ($argument->isRequired()) {
+            $message .= '<';
+        } else {
+            $message .= '[';
+        }
+        $message .= sprintf('%s', $argument->getName());
+        if ($argument->isRequired()) {
+            $message .= '>';
+        } else {
+            $message .= ']';
+        }
+        $message .= sprintf('  %s', $argument->getDescription());
+        $io->writeln($message);
+    }
+
+    exit(0);
+}
+
 $outputDir = $input->getOption('outputDir');
 $inputDir = $input->getOption('inputDir');
 $linkPrefix = $input->getOption('linkPrefix');
+try {
+    $flavor = FlavorEnum::from($input->getArgument('flavor'));
+} catch (Throwable) {
+    $io->error(
+        'Invalid flavor. Must be one of: ' . implode(
+            ', ',
+            array_map(fn (FlavorEnum $flavor) => $flavor->value, FlavorEnum::cases()),
+        ),
+    );
+    exit(1);
+}
 
-// todo: parse tocs instead?
 $fileList = [];
 if (is_file($inputDir) && (str_ends_with($inputDir, '.lua') || str_ends_with($inputDir, '.xml'))) {
     $fileList[$inputDir] = pathinfo($inputDir, PATHINFO_EXTENSION);
@@ -40,34 +105,24 @@ if (is_file($inputDir) && (str_ends_with($inputDir, '.lua') || str_ends_with($in
     $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($inputDir));
     $iterator->rewind();
 
-    $tocFiles = [];
+    $dirsWithToc = [];
     /** @var $iterator RecursiveDirectoryIterator */
     while ($iterator->valid()) {
-        if (
-            !$iterator->isDot() && $iterator->isFile()
-            && ('lua' === $iterator->getExtension() || 'xml' === $iterator->getExtension())
-        ) {
-            $fileList[$iterator->getPath() . '/' . $iterator->getFilename()] = $iterator->getExtension();
-        }
         if ('toc' === $iterator->getExtension()) {
-            $tocFiles[] = $iterator->getPath() . '/' . $iterator->getFilename();
+            $dirsWithToc[$iterator->getPath()] = true;
         }
         $iterator->next();
     }
 
-    foreach ($tocFiles as $tocFile) {
-        $toc = file_get_contents($tocFile);
-        if (str_contains($toc, '## AllowLoad: glue')) {
-            // remove all files with shared basepath from $fileList
-            $basePath = dirname($tocFile);
-            foreach ($fileList as $filePath => $extension) {
-                if (str_starts_with($filePath, $basePath)) {
-                    unset($fileList[$filePath]);
-                }
-            }
+    $tocParser = new TocFileParser($flavor);
+    foreach (array_keys($dirsWithToc) as $dirWithToc) {
+        $tocFile = $tocParser->findTocFile($dirWithToc);
+        if ($tocFile) {
+            $fileList = array_merge($fileList, $tocParser->listFiles($tocFile));
         }
     }
 }
+$fileList = array_unique($fileList);
 
 $intrinsicRegistry = new Registry();
 $templateRegistry = new Registry();
@@ -77,10 +132,10 @@ $luaFileParser = new LuaFileParser();
 
 $io->writeln('Parsing files...');
 $progressBar = $io->createProgressBar(count($fileList));
-foreach ($fileList as $filePath => $extension) {
-    if ('xml' === $extension) {
+foreach ($fileList as $filePath) {
+    if (str_ends_with($filePath, 'xml')) {
         $xmlFileParser->parse($filePath);
-    } elseif ('lua' === $extension) {
+    } elseif (str_ends_with($filePath, 'lua')) {
         $luaFileParser->parse($filePath, $inputDir, $linkPrefix);
     }
     $progressBar->advance();
@@ -89,10 +144,10 @@ $progressBar->finish();
 $io->newLine();
 $io->writeln('Writing annotations...');
 $progressBar = $io->createProgressBar(count($fileList));
-foreach($fileList as $filePath => $extension) {
-    if ('xml' === $extension) {
+foreach($fileList as $filePath) {
+    if (str_ends_with($filePath, 'xml')) {
         $xmlFileParser->writeAnnotationsToFile($filePath, $outputDir, $inputDir, $linkPrefix);
-    } elseif ('lua' === $extension) {
+    } elseif (str_ends_with($filePath, 'lua')) {
         $luaFileParser->writeAnnotationsToFile($filePath, $outputDir, $inputDir);
     }
     $progressBar->advance();
diff --git a/src/FlavorEnum.php b/src/FlavorEnum.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+enum FlavorEnum: string
+{
+    case MAINLINE = 'mainline';
+    case MISTS = 'mists';
+    case CATA = 'cata';
+    case WRATH = 'wrath';
+    case TBC = 'tbc';
+    case VANILLA = 'vanilla';
+
+    public function family(): string
+    {
+        return match ($this) {
+            self::MAINLINE => 'Mainline',
+            default => 'Classic',
+        };
+    }
+
+    public function game(): string
+    {
+        return match ($this) {
+            self::MAINLINE => 'Mainline',
+            self::MISTS => 'Mists',
+            self::CATA => 'Cata',
+            self::WRATH => 'Wrath',
+            self::TBC => 'TBC', // unconfirmed
+            self::VANILLA => 'Vanilla',
+        };
+    }
+}
diff --git a/src/TocFileParser.php b/src/TocFileParser.php
