FromEventPattern.cs 18 KB

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