feat(DaedalusVm): add various modding features

1. Adds support for passing execution flags to the VM
2. Adds support for enabling the symbol access trap
3. Adds support for marking symbol as using local variables (recursion support)

Author: lmichaelis

ZenKit/DaedalusScript.cs

@@ -96,6 +96,19 @@ public DaedalusSymbol(UIntPtr handle)
 		public bool IsMerged => Native.ZkDaedalusSymbol_getIsMerged(Handle);
 		public bool IsGenerated => Native.ZkDaedalusSymbol_getIsGenerated(Handle);
 		public bool HasReturn => Native.ZkDaedalusSymbol_getHasReturn(Handle);
+
+		public bool UseAccessTrap
+		{
+			get => Native.ZkDaedalusSymbol_getAccessTrapEnabled(Handle);
+			set => Native.ZkDaedalusSymbol_setAccessTrapEnabled(Handle, value);
+		}
+		
+		public bool UseLocalVariables
+		{
+			get => Native.ZkDaedalusSymbol_getLocalVariablesEnabled(Handle);
+			set => Native.ZkDaedalusSymbol_setLocalVariablesEnabled(Handle, value);
+		}
+		
 		public string Name => Native.ZkDaedalusSymbol_getName(Handle).MarshalAsString() ?? string.Empty;
 		public int Address => Native.ZkDaedalusSymbol_getAddress(Handle);
 		public int Parent => Native.ZkDaedalusSymbol_getParent(Handle);

ZenKit/DaedalusVm.cs

@@ -6,8 +6,17 @@
 
 namespace ZenKit
 {
+	public static class DaedalusExecutionFlags
+	{
+		public const byte Default = 0;
+		public const byte AllowNullInstanceAccess = 1 << 1;
+		public const byte IgnoreConstSpecifier = 1 << 2;
+	}
+	
 	public class DaedalusVm : DaedalusScript
 	{
+		public delegate void AccessTrapCallback(DaedalusSymbol sym);
+			
 		public delegate void ExternalDefaultFunction(DaedalusVm vm, DaedalusSymbol sym);
 
 		public delegate TR ExternalFunc<out TR>();
@@ -73,18 +82,21 @@ public delegate void ExternalFuncV<in TP0, in TP1, in TP2, in TP3, in TP4, in TP
 
 		private readonly Native.Callbacks.ZkDaedalusVmExternalDefaultCallback _nativeExternalCallbackDefault =
 			_nativeExternalCallbackDefaultHandle;
+		
+		private readonly Native.Callbacks.ZkDaedalusVmTrapCallback _nativeTrapCallback =
+			_nativeTrapCallbackHandler;
 
-		public DaedalusVm(string path) : base(Native.ZkDaedalusVm_loadPath(path), true)
+		public DaedalusVm(string path, byte flags = DaedalusExecutionFlags.Default) : base(Native.ZkDaedalusVm_loadPath(path, flags), true)
 		{
 			if (Handle == UIntPtr.Zero) throw new Exception("Failed to load DaedalusVm");
 		}
 
-		public DaedalusVm(Read r) : base(Native.ZkDaedalusVm_load(r.Handle), true)
+		public DaedalusVm(Read r, byte flags = DaedalusExecutionFlags.Default) : base(Native.ZkDaedalusVm_load(r.Handle, flags), true)
 		{
 			if (Handle == UIntPtr.Zero) throw new Exception("Failed to load DaedalusVm");
 		}
 
-		public DaedalusVm(Vfs vfs, string name) : base(Native.ZkDaedalusVm_loadVfs(vfs.Handle, name), true)
+		public DaedalusVm(Vfs vfs, string name, byte flags = DaedalusExecutionFlags.Default) : base(Native.ZkDaedalusVm_loadVfs(vfs.Handle, name, flags), true)
 		{
 			if (Handle == UIntPtr.Zero) throw new Exception("Failed to load DaedalusVm");
 		}
@@ -350,6 +362,13 @@ public void RegisterExternalDefault(ExternalDefaultFunction cb)
 			Native.ZkDaedalusVm_registerExternalDefault(Handle, _nativeExternalCallbackDefault,
 				GCHandle.ToIntPtr(gcHandle));
 		}
+		
+		public void SetAccessTrapCallback(AccessTrapCallback cb)
+		{
+			var gcHandle = GCHandle.Alloc(cb);
+			_externalCallbacks.Add(gcHandle);
+			Native.ZkDaedalusVm_setAccessTrapCallback(Handle, _nativeTrapCallback, GCHandle.ToIntPtr(gcHandle));
+		}
 
 		public void RegisterExternal<TR>(string name, ExternalFunc<TR> cb)
 		{
@@ -1023,6 +1042,14 @@ private static void _nativeExternalCallbackDefaultHandle(IntPtr ctx, UIntPtr vm,
 			cb(new DaedalusVm(vm), new DaedalusSymbol(sym));
 		}
 
+		[MonoPInvokeCallback]
+		private static void _nativeTrapCallbackHandler(IntPtr ctx, UIntPtr sym)
+		{
+			var gcHandle = GCHandle.FromIntPtr(ctx);
+			var cb = (AccessTrapCallback)gcHandle.Target;
+			cb(new DaedalusSymbol(sym));
+		}
+
 		private delegate void ExternalFunc(DaedalusVm vm);
 	}
 }

ZenKit/Native.cs

@@ -4189,7 +4189,19 @@ public static extern void ZkDaedalusScript_enumerateInstanceSymbols(UIntPtr slf,
 
         [DllImport(DllName)]
         public static extern bool ZkDaedalusSymbol_getHasReturn(UIntPtr slf);
+        
+        [DllImport(DllName)]
+        public static extern void ZkDaedalusSymbol_setAccessTrapEnabled(UIntPtr slf, bool enable);
+        
+        [DllImport(DllName)]
+        public static extern bool  ZkDaedalusSymbol_getAccessTrapEnabled(UIntPtr slf);
 
+        [DllImport(DllName)]
+        public static extern void ZkDaedalusSymbol_setLocalVariablesEnabled(UIntPtr slf, bool enable);
+        
+        [DllImport(DllName)]
+        public static extern bool  ZkDaedalusSymbol_getLocalVariablesEnabled(UIntPtr slf);
+        
         [DllImport(DllName)]
         public static extern IntPtr ZkDaedalusSymbol_getName(UIntPtr slf);
 
@@ -4227,13 +4239,13 @@ public static extern void ZkDaedalusScript_enumerateInstanceSymbols(UIntPtr slf,
         public static extern void ZkDaedalusInstance_setUserPointer(UIntPtr slf, IntPtr ptr);
 
         [DllImport(DllName)]
-        public static extern UIntPtr ZkDaedalusVm_load(UIntPtr buf);
+        public static extern UIntPtr ZkDaedalusVm_load(UIntPtr buf, byte flags);
 
         [DllImport(DllName)]
-        public static extern UIntPtr ZkDaedalusVm_loadPath([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(GothicStringMarshaller))] string path);
+        public static extern UIntPtr ZkDaedalusVm_loadPath([MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(GothicStringMarshaller))] string path, byte flags);
 
         [DllImport(DllName)]
-        public static extern UIntPtr ZkDaedalusVm_loadVfs(UIntPtr vfs, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(GothicStringMarshaller))] string name);
+        public static extern UIntPtr ZkDaedalusVm_loadVfs(UIntPtr vfs, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(GothicStringMarshaller))] string name, byte flags);
 
         [DllImport(DllName)]
         public static extern void ZkDaedalusVm_del(UIntPtr slf);
@@ -4320,6 +4332,10 @@ public static extern void ZkDaedalusVm_registerExternalDefault(UIntPtr slf,
             ZkDaedalusVmExternalDefaultCallback cb,
             IntPtr ctx);
 
+        [DllImport(DllName)]
+        public static extern void ZkDaedalusVm_setAccessTrapCallback(UIntPtr slf, ZkDaedalusVmTrapCallback cb,
+            IntPtr ctx);
+
         [DllImport(DllName)]
         public static extern void ZkDaedalusVm_printStackTrace(UIntPtr slf);
 
@@ -7899,6 +7915,9 @@ public class Callbacks
 
             [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
             public delegate void ZkDaedalusVmExternalDefaultCallback(IntPtr ctx, UIntPtr vm, UIntPtr sym);
+            
+            [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
+            public delegate void ZkDaedalusVmTrapCallback(IntPtr ctx, UIntPtr sym);
 
             [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
             public delegate void ZkLogger(IntPtr ctx, LogLevel lvl, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(GothicStringMarshaller))] string name, [MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(GothicStringMarshaller))] string message);