FromEventPattern.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  1. // Licensed to the .NET Foundation under one or more agreements.
  2. // The .NET Foundation licenses this file to you under the MIT License.
  3. // See the LICENSE file in the project root for more information.
  4. using System.Globalization;
  5. using System.Reactive.Concurrency;
  6. using System.Reactive.Disposables;
  7. using System.Reflection;
  8. using System.Runtime.ExceptionServices;
  9. using System.Threading.Tasks;
  10. namespace System.Reactive.Linq
  11. {
  12. partial class AsyncObservable
  13. {
  14. public static IAsyncObservable<EventPattern<object>> FromEventPattern(Action<EventHandler> addHandler, Action<EventHandler> removeHandler) => FromEventPattern(addHandler, removeHandler, GetSchedulerForCurrentContext());
  15. public static IAsyncObservable<EventPattern<object>> FromEventPattern(Action<EventHandler> addHandler, Action<EventHandler> removeHandler, IAsyncScheduler scheduler)
  16. {
  17. if (addHandler == null)
  18. throw new ArgumentNullException(nameof(addHandler));
  19. if (removeHandler == null)
  20. throw new ArgumentNullException(nameof(removeHandler));
  21. if (scheduler == null)
  22. throw new ArgumentNullException(nameof(scheduler));
  23. return FromEvent<EventHandler, object, EventArgs>(action => new EventHandler((o, e) => action(o, e)), addHandler, removeHandler, scheduler).Select(t => new EventPattern<object>(t.arg1, t.arg2));
  24. }
  25. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler) => FromEventPattern<TDelegate, TEventArgs>(addHandler, removeHandler, GetSchedulerForCurrentContext());
  26. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IAsyncScheduler scheduler)
  27. {
  28. if (addHandler == null)
  29. throw new ArgumentNullException(nameof(addHandler));
  30. if (removeHandler == null)
  31. throw new ArgumentNullException(nameof(removeHandler));
  32. if (scheduler == null)
  33. throw new ArgumentNullException(nameof(scheduler));
  34. return FromEvent<TDelegate, object, TEventArgs>(action => ConvertDelegate<Action<object, TEventArgs>, TDelegate>(action), addHandler, removeHandler, scheduler).Select(t => new EventPattern<TEventArgs>(t.arg1, t.arg2));
  35. }
  36. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Func<EventHandler<TEventArgs>, TDelegate> conversion, Action<TDelegate> addHandler, Action<TDelegate> removeHandler) => FromEventPattern<TDelegate, TEventArgs>(conversion, addHandler, removeHandler, GetSchedulerForCurrentContext());
  37. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Func<EventHandler<TEventArgs>, TDelegate> conversion, Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IAsyncScheduler scheduler)
  38. {
  39. if (conversion == null)
  40. throw new ArgumentNullException(nameof(conversion));
  41. if (addHandler == null)
  42. throw new ArgumentNullException(nameof(addHandler));
  43. if (removeHandler == null)
  44. throw new ArgumentNullException(nameof(removeHandler));
  45. if (scheduler == null)
  46. throw new ArgumentNullException(nameof(scheduler));
  47. return FromEvent<TDelegate, object, TEventArgs>(action => conversion(new EventHandler<TEventArgs>((o, e) => action(o, e))), addHandler, removeHandler, scheduler).Select(t => new EventPattern<TEventArgs>(t.arg1, t.arg2));
  48. }
  49. public static IAsyncObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TDelegate, TSender, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler) => FromEventPattern<TDelegate, TSender, TEventArgs>(addHandler, removeHandler, GetSchedulerForCurrentContext());
  50. public static IAsyncObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TDelegate, TSender, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IAsyncScheduler scheduler)
  51. {
  52. if (addHandler == null)
  53. throw new ArgumentNullException(nameof(addHandler));
  54. if (removeHandler == null)
  55. throw new ArgumentNullException(nameof(removeHandler));
  56. if (scheduler == null)
  57. throw new ArgumentNullException(nameof(scheduler));
  58. return FromEvent<TDelegate, TSender, TEventArgs>(action => ConvertDelegate<Action<TSender, TEventArgs>, TDelegate>(action), addHandler, removeHandler, scheduler).Select(t => new EventPattern<TSender, TEventArgs>(t.arg1, t.arg2));
  59. }
  60. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Action<EventHandler<TEventArgs>> addHandler, Action<EventHandler<TEventArgs>> removeHandler) => FromEventPattern<TEventArgs>(addHandler, removeHandler, GetSchedulerForCurrentContext());
  61. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Action<EventHandler<TEventArgs>> addHandler, Action<EventHandler<TEventArgs>> removeHandler, IAsyncScheduler scheduler)
  62. {
  63. if (addHandler == null)
  64. throw new ArgumentNullException(nameof(addHandler));
  65. if (removeHandler == null)
  66. throw new ArgumentNullException(nameof(removeHandler));
  67. if (scheduler == null)
  68. throw new ArgumentNullException(nameof(scheduler));
  69. return FromEvent<EventHandler<TEventArgs>, object, TEventArgs>(action => ConvertDelegate<Action<object, TEventArgs>, EventHandler<TEventArgs>>(action), addHandler, removeHandler, scheduler).Select(t => new EventPattern<TEventArgs>(t.arg1, t.arg2));
  70. }
  71. public static IAsyncObservable<EventPattern<object>> FromEventPattern(object target, string eventName) => FromEventPattern(target, eventName, GetSchedulerForCurrentContext());
  72. public static IAsyncObservable<EventPattern<object>> FromEventPattern(object target, string eventName, IAsyncScheduler scheduler)
  73. {
  74. if (target == null)
  75. throw new ArgumentNullException(nameof(target));
  76. if (eventName == null)
  77. throw new ArgumentNullException(nameof(eventName));
  78. if (scheduler == null)
  79. throw new ArgumentNullException(nameof(scheduler));
  80. return FromEventPatternCore<object, object, EventPattern<object>>(target.GetType(), target, eventName, scheduler, (o, e) => new EventPattern<object>(o, e));
  81. }
  82. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(object target, string eventName) => FromEventPattern<TEventArgs>(target, eventName, GetSchedulerForCurrentContext());
  83. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(object target, string eventName, IAsyncScheduler scheduler)
  84. {
  85. if (target == null)
  86. throw new ArgumentNullException(nameof(target));
  87. if (eventName == null)
  88. throw new ArgumentNullException(nameof(eventName));
  89. if (scheduler == null)
  90. throw new ArgumentNullException(nameof(scheduler));
  91. return FromEventPatternCore<object, TEventArgs, EventPattern<TEventArgs>>(target.GetType(), target, eventName, scheduler, (o, e) => new EventPattern<TEventArgs>(o, e));
  92. }
  93. public static IAsyncObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(object target, string eventName) => FromEventPattern<TSender, TEventArgs>(target, eventName, GetSchedulerForCurrentContext());
  94. public static IAsyncObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(object target, string eventName, IAsyncScheduler scheduler)
  95. {
  96. if (target == null)
  97. throw new ArgumentNullException(nameof(target));
  98. if (eventName == null)
  99. throw new ArgumentNullException(nameof(eventName));
  100. if (scheduler == null)
  101. throw new ArgumentNullException(nameof(scheduler));
  102. return FromEventPatternCore<TSender, TEventArgs, EventPattern<TSender, TEventArgs>>(target.GetType(), target, eventName, scheduler, (o, e) => new EventPattern<TSender, TEventArgs>(o, e));
  103. }
  104. public static IAsyncObservable<EventPattern<object>> FromEventPattern(Type type, string eventName) => FromEventPattern(type, eventName, GetSchedulerForCurrentContext());
  105. public static IAsyncObservable<EventPattern<object>> FromEventPattern(Type type, string eventName, IAsyncScheduler scheduler)
  106. {
  107. if (type == null)
  108. throw new ArgumentNullException(nameof(type));
  109. if (eventName == null)
  110. throw new ArgumentNullException(nameof(eventName));
  111. if (scheduler == null)
  112. throw new ArgumentNullException(nameof(scheduler));
  113. return FromEventPatternCore<object, object, EventPattern<object>>(type, null, eventName, scheduler, (o, e) => new EventPattern<object>(o, e));
  114. }
  115. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Type type, string eventName) => FromEventPattern<TEventArgs>(type, eventName, GetSchedulerForCurrentContext());
  116. public static IAsyncObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Type type, string eventName, IAsyncScheduler scheduler)
  117. {
  118. if (type == null)
  119. throw new ArgumentNullException(nameof(type));
  120. if (eventName == null)
  121. throw new ArgumentNullException(nameof(eventName));
  122. if (scheduler == null)
  123. throw new ArgumentNullException(nameof(scheduler));
  124. return FromEventPatternCore<object, TEventArgs, EventPattern<TEventArgs>>(type, null, eventName, scheduler, (o, e) => new EventPattern<TEventArgs>(o, e));
  125. }
  126. public static IAsyncObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(Type type, string eventName) => FromEventPattern<TSender, TEventArgs>(type, eventName, GetSchedulerForCurrentContext());
  127. public static IAsyncObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(Type type, string eventName, IAsyncScheduler scheduler)
  128. {
  129. if (type == null)
  130. throw new ArgumentNullException(nameof(type));
  131. if (eventName == null)
  132. throw new ArgumentNullException(nameof(eventName));
  133. if (scheduler == null)
  134. throw new ArgumentNullException(nameof(scheduler));
  135. return FromEventPatternCore<TSender, TEventArgs, EventPattern<TSender, TEventArgs>>(type, null, eventName, scheduler, (o, e) => new EventPattern<TSender, TEventArgs>(o, e));
  136. }
  137. private static IAsyncObservable<TResult> FromEventPatternCore<TSender, TEventArgs, TResult>(Type type, object target, string eventName, IAsyncScheduler scheduler, Func<TSender, TEventArgs, TResult> resultSelector)
  138. {
  139. var (addMethod, removeMethod, delegateType, isWinRT) = GetEventMethods<object, object>(target.GetType(), target, eventName);
  140. var res = default(IAsyncObservable<TResult>);
  141. if (isWinRT)
  142. {
  143. res = Create<TResult>(observer =>
  144. {
  145. var onNext = new Action<TSender, TEventArgs>((o, e) =>
  146. {
  147. observer.OnNextAsync(resultSelector(o, e)); // REVIEW: Fire-and-forget can lead to out of order processing, and observers may reject these calls as "busy".
  148. });
  149. var d = Delegate.CreateDelegate(delegateType, onNext, typeof(Action<TSender, TEventArgs>).GetMethod("Invoke"));
  150. var token = default(object);
  151. try
  152. {
  153. token = addMethod.Invoke(target, new object[] { d });
  154. }
  155. catch (TargetInvocationException tie)
  156. {
  157. ExceptionDispatchInfo.Capture(tie.InnerException).Throw();
  158. }
  159. var dispose = AsyncDisposable.Create(() =>
  160. {
  161. try
  162. {
  163. removeMethod.Invoke(target, new object[] { token });
  164. }
  165. catch (TargetInvocationException tie)
  166. {
  167. ExceptionDispatchInfo.Capture(tie.InnerException).Throw();
  168. }
  169. return default;
  170. });
  171. return Task.FromResult(dispose);
  172. });
  173. }
  174. else
  175. {
  176. res = Create<TResult>(observer =>
  177. {
  178. var onNext = new Action<TSender, TEventArgs>((o, e) =>
  179. {
  180. observer.OnNextAsync(resultSelector(o, e)); // REVIEW: Fire-and-forget can lead to out of order processing, and observers may reject these calls as "busy".
  181. });
  182. var d = Delegate.CreateDelegate(delegateType, onNext, typeof(Action<TSender, TEventArgs>).GetMethod("Invoke"));
  183. try
  184. {
  185. addMethod.Invoke(target, new object[] { d });
  186. }
  187. catch (TargetInvocationException tie)
  188. {
  189. ExceptionDispatchInfo.Capture(tie.InnerException).Throw();
  190. }
  191. var dispose = AsyncDisposable.Create(() =>
  192. {
  193. try
  194. {
  195. removeMethod.Invoke(target, new object[] { d });
  196. }
  197. catch (TargetInvocationException tie)
  198. {
  199. ExceptionDispatchInfo.Capture(tie.InnerException).Throw();
  200. }
  201. return default;
  202. });
  203. return Task.FromResult(dispose);
  204. });
  205. }
  206. return SynchronizeEvents(res, scheduler);
  207. }
  208. private static (MethodInfo addMethod, MethodInfo removeMethod, Type delegateType, bool isWinRT) GetEventMethods<TSender, TEventArgs>(Type targetType, object target, string eventName)
  209. {
  210. var e = default(EventInfo);
  211. if (target == null)
  212. {
  213. e = targetType.GetEventEx(eventName, isStatic: true);
  214. if (e == null)
  215. throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, "Could not find static event '{0}' on type '{1}'.", eventName, targetType.FullName));
  216. }
  217. else
  218. {
  219. e = targetType.GetEventEx(eventName, isStatic: false);
  220. if (e == null)
  221. throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, "Could not find instance event '{0}' on type '{1}'.", eventName, targetType.FullName));
  222. }
  223. var addMethod = e.GetAddMethod();
  224. var removeMethod = e.GetRemoveMethod();
  225. if (addMethod == null)
  226. throw new InvalidOperationException("Missing add method on event.");
  227. if (removeMethod == null)
  228. throw new InvalidOperationException("Missing remove method on event.");
  229. var psa = addMethod.GetParameters();
  230. if (psa.Length != 1)
  231. throw new InvalidOperationException("The add method of an event should take one parameter.");
  232. var psr = removeMethod.GetParameters();
  233. if (psr.Length != 1)
  234. throw new InvalidOperationException("The remove method of an event should take one parameter.");
  235. var isWinRT = false;
  236. if (addMethod.ReturnType != typeof(void))
  237. {
  238. isWinRT = true;
  239. var pet = psr[0];
  240. if (pet.ParameterType != addMethod.ReturnType)
  241. throw new InvalidOperationException("An event should either have add and remove methods that return void or an add method that returns a type compatible with the parameter type of the remove method.");
  242. }
  243. var delegateType = psa[0].ParameterType;
  244. var invokeMethod = delegateType.GetMethod("Invoke");
  245. var parameters = invokeMethod.GetParameters();
  246. if (parameters.Length != 2)
  247. throw new InvalidOperationException("The delegate type for an event conforming to the traditional event pattern should take two parameters.");
  248. if (!typeof(TSender).IsAssignableFrom(parameters[0].ParameterType))
  249. throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, "The sender parameter of the event is not assignable to '{0}'.", typeof(TSender).FullName));
  250. if (!typeof(TEventArgs).IsAssignableFrom(parameters[1].ParameterType))
  251. throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, "The event arguments parameter of the event is not assignable to '{0}'.", typeof(TEventArgs).FullName));
  252. if (invokeMethod.ReturnType != typeof(void))
  253. throw new InvalidOperationException("The return type of an event delegate should be void.");
  254. return (addMethod, removeMethod, delegateType, isWinRT);
  255. }
  256. public static EventInfo GetEventEx(this Type type, string name, bool isStatic)
  257. {
  258. return type.GetEvent(name, isStatic ? BindingFlags.Public | BindingFlags.Static : BindingFlags.Public | BindingFlags.Instance);
  259. }
  260. }
  261. }