TargetRpcProcessor.cs 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. using Mono.CecilX;
  2. using Mono.CecilX.Cil;
  3. namespace Mirror.Weaver
  4. {
  5. // Processes [TargetRpc] methods in NetworkBehaviour
  6. public static class TargetRpcProcessor
  7. {
  8. // helper functions to check if the method has a NetworkConnection parameter
  9. public static bool HasNetworkConnectionParameter(MethodDefinition md)
  10. {
  11. return md.Parameters.Count > 0 &&
  12. md.Parameters[0].ParameterType.Is<NetworkConnection>();
  13. }
  14. public static MethodDefinition ProcessTargetRpcInvoke(WeaverTypes weaverTypes, Readers readers, Logger Log, TypeDefinition td, MethodDefinition md, MethodDefinition rpcCallFunc, ref bool WeavingFailed)
  15. {
  16. string trgName = Weaver.GenerateMethodName(Weaver.InvokeRpcPrefix, md);
  17. MethodDefinition rpc = new MethodDefinition(trgName, MethodAttributes.Family |
  18. MethodAttributes.Static |
  19. MethodAttributes.HideBySig,
  20. weaverTypes.Import(typeof(void)));
  21. ILProcessor worker = rpc.Body.GetILProcessor();
  22. Instruction label = worker.Create(OpCodes.Nop);
  23. NetworkBehaviourProcessor.WriteClientActiveCheck(worker, weaverTypes, md.Name, label, "TargetRPC");
  24. // setup for reader
  25. worker.Emit(OpCodes.Ldarg_0);
  26. worker.Emit(OpCodes.Castclass, td);
  27. // NetworkConnection parameter is optional
  28. if (HasNetworkConnectionParameter(md))
  29. {
  30. // on server, the NetworkConnection parameter is a connection to client.
  31. // when the rpc is invoked on the client, it still has the same
  32. // function signature. we pass in the connection to server,
  33. // which is cleaner than just passing null)
  34. //NetworkClient.readyconnection
  35. //
  36. // TODO
  37. // a) .connectionToServer = best solution. no doubt.
  38. // b) NetworkClient.connection for now. add TODO to not use static later.
  39. worker.Emit(OpCodes.Call, weaverTypes.NetworkClientConnectionReference);
  40. }
  41. // process reader parameters and skip first one if first one is NetworkConnection
  42. if (!NetworkBehaviourProcessor.ReadArguments(md, readers, Log, worker, RemoteCallType.TargetRpc, ref WeavingFailed))
  43. return null;
  44. // invoke actual command function
  45. worker.Emit(OpCodes.Callvirt, rpcCallFunc);
  46. worker.Emit(OpCodes.Ret);
  47. NetworkBehaviourProcessor.AddInvokeParameters(weaverTypes, rpc.Parameters);
  48. td.Methods.Add(rpc);
  49. return rpc;
  50. }
  51. /* generates code like:
  52. public void TargetTest (NetworkConnection conn, int param)
  53. {
  54. NetworkWriter writer = new NetworkWriter ();
  55. writer.WritePackedUInt32 ((uint)param);
  56. base.SendTargetRPCInternal (conn, typeof(class), "TargetTest", val);
  57. }
  58. public void CallTargetTest (NetworkConnection conn, int param)
  59. {
  60. // whatever the user did before
  61. }
  62. or if optional:
  63. public void TargetTest (int param)
  64. {
  65. NetworkWriter writer = new NetworkWriter ();
  66. writer.WritePackedUInt32 ((uint)param);
  67. base.SendTargetRPCInternal (null, typeof(class), "TargetTest", val);
  68. }
  69. public void CallTargetTest (int param)
  70. {
  71. // whatever the user did before
  72. }
  73. Originally HLAPI put the send message code inside the Call function
  74. and then proceeded to replace every call to TargetTest with CallTargetTest
  75. This method moves all the user's code into the "CallTargetRpc" method
  76. and replaces the body of the original method with the send message code.
  77. This way we do not need to modify the code anywhere else, and this works
  78. correctly in dependent assemblies
  79. */
  80. public static MethodDefinition ProcessTargetRpcCall(WeaverTypes weaverTypes, Writers writers, Logger Log, TypeDefinition td, MethodDefinition md, CustomAttribute targetRpcAttr, ref bool WeavingFailed)
  81. {
  82. MethodDefinition rpc = MethodProcessor.SubstituteMethod(Log, td, md, ref WeavingFailed);
  83. ILProcessor worker = md.Body.GetILProcessor();
  84. NetworkBehaviourProcessor.WriteSetupLocals(worker, weaverTypes);
  85. NetworkBehaviourProcessor.WriteGetWriter(worker, weaverTypes);
  86. // write all the arguments that the user passed to the TargetRpc call
  87. // (skip first one if first one is NetworkConnection)
  88. if (!NetworkBehaviourProcessor.WriteArguments(worker, writers, Log, md, RemoteCallType.TargetRpc, ref WeavingFailed))
  89. return null;
  90. // invoke SendInternal and return
  91. // this
  92. worker.Emit(OpCodes.Ldarg_0);
  93. if (HasNetworkConnectionParameter(md))
  94. {
  95. // connection
  96. worker.Emit(OpCodes.Ldarg_1);
  97. }
  98. else
  99. {
  100. // null
  101. worker.Emit(OpCodes.Ldnull);
  102. }
  103. // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions
  104. worker.Emit(OpCodes.Ldstr, md.FullName);
  105. // writer
  106. worker.Emit(OpCodes.Ldloc_0);
  107. worker.Emit(OpCodes.Ldc_I4, targetRpcAttr.GetField("channel", 0));
  108. worker.Emit(OpCodes.Callvirt, weaverTypes.sendTargetRpcInternal);
  109. NetworkBehaviourProcessor.WriteReturnWriter(worker, weaverTypes);
  110. worker.Emit(OpCodes.Ret);
  111. return rpc;
  112. }
  113. }
  114. }