Allow for patch libraries to be defined with addressables

Author: cheese3660

Runtime/SassyPatching/Execution/AddressablesPatchLibrary.cs

@@ -0,0 +1,62 @@
+using System;
+using Antlr4.Runtime;
+using KSP.Game;
+using PatchManager.SassyPatching.Nodes;
+using SassyPatchGrammar;
+using UnityEngine;
+
+namespace PatchManager.SassyPatching.Execution
+{
+    internal class AddressablesPatchLibrary : PatchLibrary
+    {
+        public string Key;
+
+        public AddressablesPatchLibrary(string key)
+        {
+            Key = key;
+        }
+        
+        private SassyPatch? _patch;
+
+        public override void RegisterInto(Environment environment)
+        {
+            if (_patch == null)
+            {
+                var universe = environment.GlobalEnvironment.Universe;
+                universe.MessageLogger.Invoke(
+                    $"Loading library from addressables {Key}");
+                var handle = GameManager.Instance.Assets.LoadAssetAsync<TextAsset>(Key);
+                handle.WaitForCompletion();
+                var text = handle.Result;
+                if (text != null)
+                {
+                    var patchText = text.text;
+                    var charStream = CharStreams.fromString(patchText);
+                    var lexerErrorGenerator = new Universe.LexerListener(Key, universe.ErrorLogger);
+                    var lexer = new sassy_lexer(charStream);
+                    lexer.AddErrorListener(lexerErrorGenerator);
+                    if (lexerErrorGenerator.Errored)
+                    {
+                        throw new Exception("lexer errors detected");
+                    }
+                    var tokenStream = new CommonTokenStream(lexer);
+                    var parser = new sassy_parser(tokenStream);
+                    var parserErrorGenerator = new Universe.ParserListener(Key, universe.ErrorLogger);
+                    parser.AddErrorListener(parserErrorGenerator);
+                    var patchContext = parser.patch();
+                    if (parserErrorGenerator.Errored)
+                    {
+                        throw new Exception("parser errors detected");
+                    }
+                    var tokenTransformer = new Transformer(msg => throw new Exception(msg));
+                    _patch = tokenTransformer.Visit(patchContext) as SassyPatch;
+                }
+                else
+                {
+                    throw new Exception("Addressables patch not found!");
+                }
+            }
+            _patch?.ExecuteIn(environment);
+        }
+    }
+}

Runtime/SassyPatching/Execution/AddressablesPatchLibrary.cs.meta

@@ -13,6 +13,7 @@
 using PatchManager.SassyPatching.Utility;
 using PatchManager.Shared;
 using UniLinq;
+using Unity.VisualScripting;
 
 namespace PatchManager.SassyPatching.Execution
 {
@@ -109,7 +110,7 @@ public void AddConfigUpdater(long priority, string label, string? name, Expressi
         /// <summary>
         /// This logs errors in this universe
         /// </summary>
-        private readonly Action<string> _errorLogger;
+        public readonly Action<string> ErrorLogger;
 
 
         /// <summary>
@@ -133,7 +134,7 @@ public void AddConfigUpdater(long priority, string label, string? name, Expressi
         public Universe(Action<ITextPatcher> registerPatcher, Action<string> errorLogger, Action<string> messageLogger, Action<ITextAssetGenerator> registerGenerator, List<string> allMods)
         {
             RegisterPatcher = registerPatcher;
-            _errorLogger = errorLogger;
+            ErrorLogger = errorLogger;
             MessageLogger = messageLogger;
             RegisterGenerator = registerGenerator;
             LoadedLabels = new List<string>(_preloadedLabels);
@@ -243,13 +244,13 @@ private void LoadSinglePatch(string modId, FileInfo patch, Transformer tokenTran
                 MessageLogger.Invoke($"Loading patch {modId}:{patch.Name}");
                 var charStream = CharStreams.fromPath(patch.FullName);
                 var lexer = new sassy_lexer(charStream);
-                var lexerErrorGenerator = new LexerListener($"{modId}:{patch.Name}", _errorLogger);
+                var lexerErrorGenerator = new LexerListener($"{modId}:{patch.Name}", ErrorLogger);
                 lexer.AddErrorListener(lexerErrorGenerator);
                 if (lexerErrorGenerator.Errored)
                     throw new LoadException("lexer errors detected");
                 var tokenStream = new CommonTokenStream(lexer);
                 var parser = new sassy_parser(tokenStream);
-                var parserErrorGenerator = new ParserListener($"{modId}:{patch.Name}", _errorLogger);
+                var parserErrorGenerator = new ParserListener($"{modId}:{patch.Name}", ErrorLogger);
                 parser.AddErrorListener(parserErrorGenerator);
                 var patchContext = parser.patch();
                 if (parserErrorGenerator.Errored)
@@ -263,7 +264,7 @@ private void LoadSinglePatch(string modId, FileInfo patch, Transformer tokenTran
             }
             catch (Exception e)
             {
-                _errorLogger($"Could not run patch: {modId}:{patch.Name} due to: {e}");
+                ErrorLogger($"Could not run patch: {modId}:{patch.Name} due to: {e}");
             }
         }
 
@@ -274,14 +275,14 @@ private void LoadSingleLibrary(string modId, FileInfo library, Transformer token
             {
                 MessageLogger.Invoke($"Loading library {name}");
                 var charStream = CharStreams.fromPath(library.FullName);
-                var lexerErrorGenerator = new LexerListener(name, _errorLogger);
+                var lexerErrorGenerator = new LexerListener(name, ErrorLogger);
                 var lexer = new sassy_lexer(charStream);
                 lexer.AddErrorListener(lexerErrorGenerator);
                 if (lexerErrorGenerator.Errored)
                     throw new LoadException("lexer errors detected");
                 var tokenStream = new CommonTokenStream(lexer);
                 var parser = new sassy_parser(tokenStream);
-                var parserErrorGenerator = new ParserListener(name, _errorLogger);
+                var parserErrorGenerator = new ParserListener(name, ErrorLogger);
                 parser.AddErrorListener(parserErrorGenerator);
                 if (parserErrorGenerator.Errored)
                     throw new LoadException("parser errors detected");
@@ -293,7 +294,7 @@ private void LoadSingleLibrary(string modId, FileInfo library, Transformer token
             }
             catch (Exception e)
             {
-                _errorLogger($"Could not load library: {name} due to: {e.Message}");
+                ErrorLogger($"Could not load library: {name} due to: {e.Message}");
             }
         }
 
@@ -469,5 +470,10 @@ private void SetupBasePriorities(List<string> modLoadOrder)
             LastImplicitGlobal = lastPost;
             MessageLogger($"Last implicit global: {lastPost}");
         }
+
+        public static void RegisterAddressablesLibrary(string modId, string name, string key)
+        {
+            AllManagedLibraries.Add($"{modId}:{name}", new AddressablesPatchLibrary(key));
+        }
     }
 }