Skip to content

Fix Smarter Construction compat for 1.6 cache refactor (#598) #600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
M-r-A wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fix Smarter Construction compat for 1.6 cache refactor (#598) #600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 161 additions & 54 deletions Source/Mods/SmarterConstruction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,74 +1,181 @@
using System.Collections;
using System;
using System.Collections;
using System.Reflection;
using HarmonyLib;
using Verse;

namespace Multiplayer.Compat
namespace Multiplayer.Compat;

/// <summary>Smarter Construction by Hultis</summary>
/// <see href="https://github.com/dhultgren/rimworld-smarter-construction"/>
/// <see href="https://steamcommunity.com/sharedfiles/filedetails/?id=2202185773"/>
[MpCompatFor("dhultgren.smarterconstruction")]
internal class SmarterConstruction
{
/// <summary>Smarter Construction by Hultis</summary>
/// <see href="https://github.com/dhultgren/rimworld-smarter-construction"/>
/// <see href="https://steamcommunity.com/sharedfiles/filedetails/?id=2202185773"/>
[MpCompatFor("dhultgren.smarterconstruction")]
class SmarterConstruction
// Patch_WorkGiver_Scanner_GetPriority
private static AccessTools.FieldRef<IDictionary> workGiverScannerCacheField;

// Pre-1.6 static caches
// ClosedRegionDetector
private static AccessTools.FieldRef<object> closedRegionDetectorCacheField;

// EncloseThingsCache
private static AccessTools.FieldRef<object, IDictionary> encloseThingsCacheField;

// PawnPositionCache
private static FieldInfo positionsCacheField;
private static FieldInfo lastPositionsCacheCleanupField;

// 1.6+ per-map MapComponent caches
private static MethodInfo encloseThingsGetCacheMethod;
private static MethodInfo pawnPositionGetCacheMethod;
private static FieldInfo encloseThingsMapCacheField;
private static FieldInfo pawnPositionMapCacheField;
private static FieldInfo pawnPositionLastCleanupField;

private static Action clearSecondaryCaches;

// WorkGiver_ConstructFinishFrames_JobOnThing
private static AccessTools.FieldRef<int> constructFinishFrameCurrentTickField;

public SmarterConstruction(ModContentPack mod)
{
// Patch_WorkGiver_Scanner_GetPriority
private static AccessTools.FieldRef<IDictionary> workGiverScannerCacheField;
// ClosedRegionDetector
private static AccessTools.FieldRef<object> closedRegionDetectorCacheField;
// EncloseThingsCache
private static AccessTools.FieldRef<object, IDictionary> encloseThingsCacheField;
// PawnPositionCache
private static FieldInfo positionsCacheField;
private static FieldInfo lastPositionsCacheCleanupField;
// WorkGiver_ConstructFinishFrames_JobOnThing
private static AccessTools.FieldRef<int> constructFinishFrameCurrentTickField;

public SmarterConstruction(ModContentPack mod)
var type = AccessTools.TypeByName("SmarterConstruction.Patches.Patch_WorkGiver_Scanner_GetPriority");

// RNG
{
var type = AccessTools.TypeByName("SmarterConstruction.Patches.Patch_WorkGiver_Scanner_GetPriority");
var field = AccessTools.Field(type, "random");
field.SetValue(null, PatchingUtilities.RandRedirector.Instance);
}

// RNG
{
var field = AccessTools.Field(type, "random");
// Cache
{
workGiverScannerCacheField = AccessTools.StaticFieldRefAccess<IDictionary>(
AccessTools.DeclaredField(type, "cache"));

field.SetValue(null, PatchingUtilities.RandRedirector.Instance);
// SC 1.6 moved enclose/pawn caches from static fields to per-map MapComponents.
if (UsesMapComponentLayout())
{
InitMapComponentCaches();
clearSecondaryCaches = ClearMapComponentCaches;
}
else
{
InitStaticCaches();
clearSecondaryCaches = ClearStaticCaches;
}

// Cache
constructFinishFrameCurrentTickField = AccessTools.StaticFieldRefAccess<int>(
AccessTools.DeclaredField(
"SmarterConstruction.Patches.WorkGiver_ConstructFinishFrames_JobOnThing:currentTick"));

MpCompat.harmony.Patch(
AccessTools.DeclaredMethod(typeof(GameComponentUtility), nameof(GameComponentUtility.FinalizeInit)),
postfix: new HarmonyMethod(typeof(SmarterConstruction), nameof(ClearCache)));
}
}

private static bool UsesMapComponentLayout()
{
var encloseThingsCacheType = AccessTools.TypeByName("SmarterConstruction.Core.EncloseThingsCache");
return encloseThingsCacheType != null
&& typeof(MapComponent).IsAssignableFrom(encloseThingsCacheType)
&& AccessTools.Method(
encloseThingsCacheType,
"GetCache",
new[]
{
typeof(Map)
}) != null;
}

private static void InitStaticCaches()
{
closedRegionDetectorCacheField = AccessTools.StaticFieldRefAccess<object>(
AccessTools.DeclaredField("SmarterConstruction.Core.ClosedRegionDetector:cache"));
encloseThingsCacheField =
AccessTools.FieldRefAccess<IDictionary>("SmarterConstruction.Core.EncloseThingsCache:cache");

var pawnPositionCacheType = AccessTools.TypeByName("SmarterConstruction.Core.PawnPositionCache");
// Harmony seems to fail to create FieldRef<T> on those 2, so just gonna use FieldInfo instead.
positionsCacheField = AccessTools.DeclaredField(pawnPositionCacheType, "positionCache");
lastPositionsCacheCleanupField = AccessTools.DeclaredField(pawnPositionCacheType, "lastCacheCleanup");
}

private static void InitMapComponentCaches()
{
var encloseThingsCacheType = AccessTools.TypeByName("SmarterConstruction.Core.EncloseThingsCache");
var pawnPositionCacheType = AccessTools.TypeByName("SmarterConstruction.Core.PawnPositionCache");

encloseThingsGetCacheMethod = AccessTools.Method(
encloseThingsCacheType,
"GetCache",
new[]
{
workGiverScannerCacheField = AccessTools.StaticFieldRefAccess<IDictionary>(AccessTools.DeclaredField(type, "cache"));
typeof(Map)
});
pawnPositionGetCacheMethod = AccessTools.Method(
pawnPositionCacheType,
"GetCache",
new[]
{
typeof(Map)
});

closedRegionDetectorCacheField = AccessTools.StaticFieldRefAccess<object>(
AccessTools.DeclaredField("SmarterConstruction.Core.ClosedRegionDetector:cache"));
encloseThingsCacheField = AccessTools.FieldRefAccess<IDictionary>("SmarterConstruction.Core.EncloseThingsCache:cache");
encloseThingsMapCacheField = AccessTools.DeclaredField(encloseThingsCacheType, "_cache")
?? AccessTools.DeclaredField(encloseThingsCacheType, "cache");
pawnPositionMapCacheField = AccessTools.DeclaredField(pawnPositionCacheType, "_positionCache")
?? AccessTools.DeclaredField(pawnPositionCacheType, "positionCache");
pawnPositionLastCleanupField = AccessTools.DeclaredField(pawnPositionCacheType, "_lastCacheCleanup")
?? AccessTools.DeclaredField(pawnPositionCacheType, "lastCacheCleanup");
}

type = AccessTools.TypeByName("SmarterConstruction.Core.PawnPositionCache");
// Harmony seems to fail to create FieldRef<T> on those 2, so just gonna use FieldInfo instead.
positionsCacheField = AccessTools.DeclaredField(type, "positionCache");
lastPositionsCacheCleanupField = AccessTools.DeclaredField(type, "lastCacheCleanup");
private static void ClearCache()
{
workGiverScannerCacheField().Clear();
clearSecondaryCaches();

constructFinishFrameCurrentTickField = AccessTools.StaticFieldRefAccess<int>(
AccessTools.DeclaredField("SmarterConstruction.Patches.WorkGiver_ConstructFinishFrames_JobOnThing:currentTick"));
// Small chance it could cause issues when the loaded game is on the same tick as the tick stored by this field
constructFinishFrameCurrentTickField() = -1;
// Since we set the current tick to -1 (as opposed to 0), there's no chance unless something
// is very wrong for `thingsUpdatedThisTick` field to be valid and kept by the mod. No need to clean it.
}

MpCompat.harmony.Patch(AccessTools.DeclaredMethod(typeof(GameComponentUtility), nameof(GameComponentUtility.FinalizeInit)),
postfix: new HarmonyMethod(typeof(SmarterConstruction), nameof(ClearCache)));
}
}
private static void ClearStaticCaches()
{
encloseThingsCacheField(closedRegionDetectorCacheField()).Clear();

private static void ClearCache()
((IDictionary)positionsCacheField.GetValue(null)).Clear();
// Reset the last cleanup tick field, as if we load an older save - it'll have to wait until the previously assigned tick to clean up.
lastPositionsCacheCleanupField.SetValue(null, 0);
}

private static void ClearMapComponentCaches()
{
foreach (var map in Find.Maps)
{
workGiverScannerCacheField().Clear();
// ClosedRegionDetector.cache.cache.Clear();
encloseThingsCacheField(closedRegionDetectorCacheField()).Clear();

((IDictionary)positionsCacheField.GetValue(null)).Clear();
// Reset the last cleanup tick field, as if we load an older save - it'll have to wait until the previously assigned tick to cleanup.
lastPositionsCacheCleanupField.SetValue(null, 0);

// Small chance it could cause issues when the loaded game is on the same tick as the tick stored by this field
constructFinishFrameCurrentTickField() = -1;
// Since we set the current tick to -1 (as opposed to 0), there's no chance unless something
// is very wrong for `thingsUpdatedThisTick` field to be valid and kept by the mod. No need to clean it.
var encloseThingsCache = encloseThingsGetCacheMethod.Invoke(
null,
new object[]
{
map
});
if (encloseThingsCache != null)
{
((IDictionary)encloseThingsMapCacheField.GetValue(encloseThingsCache)).Clear();
}

var pawnPositionCache = pawnPositionGetCacheMethod.Invoke(
null,
new object[]
{
map
});
if (pawnPositionCache != null)
{
((IDictionary)pawnPositionMapCacheField.GetValue(pawnPositionCache)).Clear();
pawnPositionLastCleanupField.SetValue(pawnPositionCache, 0);
}
}
}
}
}