CommandProcessor.cs 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. using Mono.CecilX;
  2. using Mono.CecilX.Cil;
  3. namespace Mirror.Weaver
  4. {
  5. // Processes [Command] methods in NetworkBehaviour
  6. public static class CommandProcessor
  7. {
  8. /*
  9. // generates code like:
  10. public void CmdThrust(float thrusting, int spin)
  11. {
  12. NetworkWriter networkWriter = new NetworkWriter();
  13. networkWriter.Write(thrusting);
  14. networkWriter.WritePackedUInt32((uint)spin);
  15. base.SendCommandInternal(cmdName, networkWriter, channel);
  16. }
  17. public void CallCmdThrust(float thrusting, int spin)
  18. {
  19. // whatever the user was doing before
  20. }
  21. Originally HLAPI put the send message code inside the Call function
  22. and then proceeded to replace every call to CmdTrust with CallCmdTrust
  23. This method moves all the user's code into the "CallCmd" method
  24. and replaces the body of the original method with the send message code.
  25. This way we do not need to modify the code anywhere else, and this works
  26. correctly in dependent assemblies
  27. */
  28. public static MethodDefinition ProcessCommandCall(WeaverTypes weaverTypes, Writers writers, Logger Log, TypeDefinition td, MethodDefinition md, CustomAttribute commandAttr, ref bool WeavingFailed)
  29. {
  30. MethodDefinition cmd = MethodProcessor.SubstituteMethod(Log, td, md, ref WeavingFailed);
  31. ILProcessor worker = md.Body.GetILProcessor();
  32. NetworkBehaviourProcessor.WriteSetupLocals(worker, weaverTypes);
  33. // NetworkWriter writer = new NetworkWriter();
  34. NetworkBehaviourProcessor.WriteGetWriter(worker, weaverTypes);
  35. // write all the arguments that the user passed to the Cmd call
  36. if (!NetworkBehaviourProcessor.WriteArguments(worker, writers, Log, md, RemoteCallType.Command, ref WeavingFailed))
  37. return null;
  38. int channel = commandAttr.GetField("channel", 0);
  39. bool requiresAuthority = commandAttr.GetField("requiresAuthority", true);
  40. // invoke internal send and return
  41. // load 'base.' to call the SendCommand function with
  42. worker.Emit(OpCodes.Ldarg_0);
  43. // pass full function name to avoid ClassA.Func <-> ClassB.Func collisions
  44. worker.Emit(OpCodes.Ldstr, md.FullName);
  45. // writer
  46. worker.Emit(OpCodes.Ldloc_0);
  47. worker.Emit(OpCodes.Ldc_I4, channel);
  48. // requiresAuthority ? 1 : 0
  49. worker.Emit(requiresAuthority ? OpCodes.Ldc_I4_1 : OpCodes.Ldc_I4_0);
  50. worker.Emit(OpCodes.Call, weaverTypes.sendCommandInternal);
  51. NetworkBehaviourProcessor.WriteReturnWriter(worker, weaverTypes);
  52. worker.Emit(OpCodes.Ret);
  53. return cmd;
  54. }
  55. /*
  56. // generates code like:
  57. protected static void InvokeCmdCmdThrust(NetworkBehaviour obj, NetworkReader reader, NetworkConnection senderConnection)
  58. {
  59. if (!NetworkServer.active)
  60. {
  61. return;
  62. }
  63. ((ShipControl)obj).CmdThrust(reader.ReadSingle(), (int)reader.ReadPackedUInt32());
  64. }
  65. */
  66. public static MethodDefinition ProcessCommandInvoke(WeaverTypes weaverTypes, Readers readers, Logger Log, TypeDefinition td, MethodDefinition method, MethodDefinition cmdCallFunc, ref bool WeavingFailed)
  67. {
  68. string cmdName = Weaver.GenerateMethodName(Weaver.InvokeRpcPrefix, method);
  69. MethodDefinition cmd = new MethodDefinition(cmdName,
  70. MethodAttributes.Family | MethodAttributes.Static | MethodAttributes.HideBySig,
  71. weaverTypes.Import(typeof(void)));
  72. ILProcessor worker = cmd.Body.GetILProcessor();
  73. Instruction label = worker.Create(OpCodes.Nop);
  74. NetworkBehaviourProcessor.WriteServerActiveCheck(worker, weaverTypes, method.Name, label, "Command");
  75. // setup for reader
  76. worker.Emit(OpCodes.Ldarg_0);
  77. worker.Emit(OpCodes.Castclass, td);
  78. if (!NetworkBehaviourProcessor.ReadArguments(method, readers, Log, worker, RemoteCallType.Command, ref WeavingFailed))
  79. return null;
  80. AddSenderConnection(method, worker);
  81. // invoke actual command function
  82. worker.Emit(OpCodes.Callvirt, cmdCallFunc);
  83. worker.Emit(OpCodes.Ret);
  84. NetworkBehaviourProcessor.AddInvokeParameters(weaverTypes, cmd.Parameters);
  85. td.Methods.Add(cmd);
  86. return cmd;
  87. }
  88. static void AddSenderConnection(MethodDefinition method, ILProcessor worker)
  89. {
  90. foreach (ParameterDefinition param in method.Parameters)
  91. {
  92. if (NetworkBehaviourProcessor.IsSenderConnection(param, RemoteCallType.Command))
  93. {
  94. // NetworkConnection is 3nd arg (arg0 is "obj" not "this" because method is static)
  95. // example: static void InvokeCmdCmdSendCommand(NetworkBehaviour obj, NetworkReader reader, NetworkConnection connection)
  96. worker.Emit(OpCodes.Ldarg_2);
  97. }
  98. }
  99. }
  100. }
  101. }