Changeset 28093

Timestamp:

May 22, 2024, 5:52:12 PM (2 months ago)

Author:

phosit

Message:

Allow to use a generator as MapGenerator

This way it's clear what's the input and what's the output of the computation.
All map generation scripts should reman working. They are adopted in a future commit.

Engine.SetProgress and Engine.ExportMap can be removed in a future commit.

Comments by: @marder, @sera, @Stan

Differential Revision: ​https://code.wildfiregames.com/D5220

Location:

ps/trunk

Files:

• binaries/data/mods/public/maps/random/rmgen/RandomMap.js (modified) (3 diffs)
• binaries/data/mods/public/maps/random/tests/test_Generator.js (added)
• binaries/data/mods/public/maps/random/tests/test_RecoverableError.js (added)
• binaries/data/tests/test_setup.js (modified) (1 diff)
• source/graphics/MapGenerator.cpp (modified) (3 diffs)
• source/graphics/tests/test_MapGenerator.h (modified) (3 diffs)
• source/scriptinterface/FunctionWrapper.h (modified) (4 diffs)

ps/trunk/binaries/data/mods/public/maps/random/rmgen/RandomMap.js

@@ -480 +480 @@
 };
 
-RandomMap.prototype.ExportMap = function()
+RandomMap.prototype. = function()
 {
     if (g_Environment.Water.WaterBody.Height === undefined)
@@ -487 +487 @@
     this.logger.close();
 
-    Engine.ExportMap({
+    {
         "entities": this.exportEntityList(),
         "height": this.exportHeightData(),
@@ -496 +496 @@
         "Camera": g_Camera,
         "Environment": g_Environment
-    });
-};
+    };
+};
+
+RandomMap.prototype.ExportMap = function()
+{
+    Engine.ExportMap(this.MakeExportable());
+};

ps/trunk/binaries/data/tests/test_setup.js

@@ -31 +31 @@
     if (x !== y)
         fail("Expected equal, got " + uneval(x) + " !== " + uneval(y));
+
+
+
+
+
+
 };
 

ps/trunk/source/graphics/MapGenerator.cpp

@@ -1 @@
-/* Copyright (C) 2023 Wildfire Games.
+/* Copyright (C) 202 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -48 +48 @@
 namespace
 {
+
+
 bool MapGenerationInterruptCallback(JSContext* UNUSED(cx))
 {
@@ -424 +426 @@
     }
 
-    return mapData;
+    LOGMESSAGE("Run RMS generator");
+    bool hasGenerator;
+    JS::RootedObject globalAsObject{rq.cx, &JS::HandleValue{global}.toObject()};
+    if (!JS_HasProperty(rq.cx, globalAsObject, GENERATOR_NAME, &hasGenerator))
+    {
+        LOGERROR("RunMapGenerationScript: failed to search `%s`.", GENERATOR_NAME);
+        return nullptr;
+    }
+
+    if (mapData != nullptr)
+    {
+        LOGWARNING("The map generation script called `Engine.ExportMap` that's deprecated. The "
+            "generator based interface should be used.");
+        if (hasGenerator)
+            LOGWARNING("The map generation script contains a `%s` but `Engine.ExportMap` was already "
+                "called. `%s` isn't called, preserving the old behavior.", GENERATOR_NAME,
+                GENERATOR_NAME);
+        return mapData;
+    }
+
+    try
+    {
+        JS::RootedValue map{rq.cx, ScriptFunction::RunGenerator(rq, global, GENERATOR_NAME, settingsVal,
+            [&](const JS::HandleValue value)
+            {
+                int tempProgress;
+                if (!Script::FromJSVal(rq, value, tempProgress))
+                    throw std::runtime_error{"Failed to convert the yielded value to an "
+                        "integer."};
+                progress.store(tempProgress);
+            })};
+
+        JS::RootedValue exportedMap{rq.cx};
+        const bool exportSuccess{ScriptFunction::Call(rq, map, "MakeExportable", &exportedMap)};
+        return Script::WriteStructuredClone(rq, exportSuccess ? exportedMap : map);
+    }
+    catch(const std::exception& e)
+    {
+        LOGERROR("%s", e.what());
+        return nullptr;
+    }
+    catch(...)
+    {
+        return nullptr;
+    }
 }

ps/trunk/source/graphics/tests/test_MapGenerator.h

@@ -1 @@
-/* Copyright (C) 2023 Wildfire Games.
+/* Copyright (C) 202 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -52 +52 @@
         for (const VfsPath& path : paths)
         {
+
             ScriptInterface scriptInterface("Engine", "MapGenerator", g_ScriptContext);
             ScriptTestSetup(scriptInterface);
 
-            // It's never read in the test so it doesn't matter to what value it's initialized. For
-            // good practice it's initialized to 1.
             std::atomic<int> progress{1};
 
@@ -62 +61 @@
                 path, "{\"Seed\": 0}", JSPROP_ENUMERATE | JSPROP_PERMANENT)};
 
-            // The test scripts don't call `ExportMap` so `RunMapGenerationScript` allways returns
-            // `nullptr`.
-            TS_ASSERT_EQUALS(result, nullptr);
+            if (path == "maps/random/tests/test_Generator.js" ||
+                path == "maps/random/tests/test_RecoverableError.js")
+            {
+                TS_ASSERT_EQUALS(progress.load(), 50);
+                TS_ASSERT_DIFFERS(result, nullptr);
+            }
+            else
+            {
+                // The test scripts don't call `ExportMap` so `RunMapGenerationScript` allways
+                // returns `nullptr`.
+                TS_ASSERT_EQUALS(result, nullptr);
+                // Because the test scripts don't call `ExportMap`, `GenerateMap` is searched, which
+                // doesn't exist.
+                TS_ASSERT_STR_CONTAINS(logger.GetOutput(),
+                    "Failed to call the generator `GenerateMap`.");
+            }
         }
     }

ps/trunk/source/scriptinterface/FunctionWrapper.h

@@ -1 @@
-/* Copyright (C) 2023 Wildfire Games.
+/* Copyright (C) 202 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -23 +23 @@
 #include "ScriptRequest.h"
 
+
 #include <tuple>
 #include <type_traits>
+
 #include <utility>
 
@@ -81 +83 @@
     struct args_info<R(C::*)(Types ...) const> : public args_info<R(C::*)(Types ...)> {};
 
+
+
+
+
+
+
+
+
+
+
+
     ///////////////////////////////////////////////////////////////////////////
     ///////////////////////////////////////////////////////////////////////////
@@ -348 +361 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * Return a function spec from a C++ function.
      */