TargetRpcProcessor.cs 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  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. MethodDefinition rpc = new MethodDefinition(Weaver.InvokeRpcPrefix + md.Name, MethodAttributes.Family |
  17. MethodAttributes.Static |
  18. MethodAttributes.HideBySig,
  19. weaverTypes.Import(typeof(void)));
  20. ILProcessor worker = rpc.Body.GetILProcessor();
  21. Instruction label = worker.Create(OpCodes.Nop);
  22. NetworkBehaviourProcessor.WriteClientActiveCheck(worker, weaverTypes, md.Name, label, "TargetRPC");
  23. // setup for reader
  24. worker.Emit(OpCodes.Ldarg_0);
  25. worker.Emit(OpCodes.Castclass, td);
  26. // NetworkConnection parameter is optional
  27. if (HasNetworkConnectionParameter(md))
  28. {
  29. // on server, the NetworkConnection parameter is a connection to client.
  30. // when the rpc is invoked on the client, it still has the same
  31. // function signature. we pass in the connection to server,
  32. // which is cleaner than just passing null)
  33. //NetworkClient.readyconnection
  34. //
  35. // TODO
  36. // a) .connectionToServer = best solution. no doubt.
  37. // b) NetworkClient.connection for now. add TODO to not use static later.
  38. worker.Emit(OpCodes.Call, weaverTypes.NetworkClientConnectionReference);
  39. }
  40. // process reader parameters and skip first one if first one is NetworkConnection
  41. if (!NetworkBehaviourProcessor.ReadArguments(md, readers, Log, worker, RemoteCallType.TargetRpc, ref WeavingFailed))
  42. return null;
  43. // invoke actual command function
  44. worker.Emit(OpCodes.Callvirt, rpcCallFunc);
  45. worker.Emit(OpCodes.Ret);
  46. NetworkBehaviourProcessor.AddInvokeParameters(weaverTypes, rpc.Parameters);
  47. td.Methods.Add(rpc);
  48. return rpc;
  49. }
  50. /* generates code like:
  51. public void TargetTest (NetworkConnection conn, int param)
  52. {
  53. NetworkWriter writer = new NetworkWriter ();
  54. writer.WritePackedUInt32 ((uint)param);
  55. base.SendTargetRPCInternal (conn, typeof(class), "TargetTest", val);
  56. }
  57. public void CallTargetTest (NetworkConnection conn, int param)
  58. {
  59. // whatever the user did before
  60. }
  61. or if optional:
  62. public void TargetTest (int param)
  63. {
  64. NetworkWriter writer = new NetworkWriter ();
  65. writer.WritePackedUInt32 ((uint)param);
  66. base.SendTargetRPCInternal (null, typeof(class), "TargetTest", val);
  67. }
  68. public void CallTargetTest (int param)
  69. {
  70. // whatever the user did before
  71. }
  72. Originally HLAPI put the send message code inside the Call function
  73. and then proceeded to replace every call to TargetTest with CallTargetTest
  74. This method moves all the user's code into the "CallTargetRpc" method
  75. and replaces the body of the original method with the send message code.
  76. This way we do not need to modify the code anywhere else, and this works
  77. correctly in dependent assemblies
  78. */
  79. public static MethodDefinition ProcessTargetRpcCall(WeaverTypes weaverTypes, Writers writers, Logger Log, TypeDefinition td, MethodDefinition md, CustomAttribute targetRpcAttr, ref bool WeavingFailed)
  80. {
  81. MethodDefinition rpc = MethodProcessor.SubstituteMethod(Log, td, md, ref WeavingFailed);
  82. ILProcessor worker = md.Body.GetILProcessor();
  83. NetworkBehaviourProcessor.WriteSetupLocals(worker, weaverTypes);
  84. NetworkBehaviourProcessor.WriteCreateWriter(worker, weaverTypes);
  85. // write all the arguments that the user passed to the TargetRpc call
  86. // (skip first one if first one is NetworkConnection)
  87. if (!NetworkBehaviourProcessor.WriteArguments(worker, writers, Log, md, RemoteCallType.TargetRpc, ref WeavingFailed))
  88. return null;
  89. string rpcName = md.Name;
  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. worker.Emit(OpCodes.Ldtoken, td);
  104. // invokerClass
  105. worker.Emit(OpCodes.Call, weaverTypes.getTypeFromHandleReference);
  106. worker.Emit(OpCodes.Ldstr, rpcName);
  107. // writer
  108. worker.Emit(OpCodes.Ldloc_0);
  109. worker.Emit(OpCodes.Ldc_I4, targetRpcAttr.GetField("channel", 0));
  110. worker.Emit(OpCodes.Callvirt, weaverTypes.sendTargetRpcInternal);
  111. NetworkBehaviourProcessor.WriteRecycleWriter(worker, weaverTypes);
  112. worker.Emit(OpCodes.Ret);
  113. return rpc;
  114. }
  115. }
  116. }