forked from reactiveui/ReactiveUI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIReactiveObject.cs
More file actions
315 lines (259 loc) · 13.4 KB
/
IReactiveObject.cs
File metadata and controls
315 lines (259 loc) · 13.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MS-PL license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics.Contracts;
using System.Reactive;
using System.Reactive.Concurrency;
using System.Reactive.Disposables;
using System.Reactive.Linq;
using System.Reactive.Subjects;
using System.Runtime.CompilerServices;
using System.Threading;
using Splat;
namespace ReactiveUI
{
public interface IReactiveObject : INotifyPropertyChanged, INotifyPropertyChanging, IEnableLogger
{
void RaisePropertyChanging(PropertyChangingEventArgs args);
void RaisePropertyChanged(PropertyChangedEventArgs args);
}
[Preserve(AllMembers = true)]
public static class IReactiveObjectExtensions
{
static ConditionalWeakTable<IReactiveObject, IExtensionState<IReactiveObject>> state = new ConditionalWeakTable<IReactiveObject, IExtensionState<IReactiveObject>>();
internal static IObservable<IReactivePropertyChangedEventArgs<TSender>> getChangedObservable<TSender>(this TSender This) where TSender : IReactiveObject
{
var val = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
return val.Changed.Cast<IReactivePropertyChangedEventArgs<TSender>>();
}
internal static IObservable<IReactivePropertyChangedEventArgs<TSender>> getChangingObservable<TSender>(this TSender This) where TSender : IReactiveObject
{
var val = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
return val.Changing.Cast<IReactivePropertyChangedEventArgs<TSender>>();
}
internal static IObservable<Exception> getThrownExceptionsObservable<TSender>(this TSender This) where TSender : IReactiveObject
{
var s = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
return s.ThrownExceptions;
}
internal static void raisePropertyChanging<TSender>(this TSender This, string propertyName) where TSender : IReactiveObject
{
Contract.Requires(propertyName != null);
var s = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
s.raisePropertyChanging(propertyName);
}
internal static void raisePropertyChanged<TSender>(this TSender This, string propertyName) where TSender : IReactiveObject
{
Contract.Requires(propertyName != null);
var s = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
s.raisePropertyChanged(propertyName);
}
internal static IDisposable suppressChangeNotifications<TSender>(this TSender This) where TSender : IReactiveObject
{
var s = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
return s.suppressChangeNotifications();
}
internal static bool areChangeNotificationsEnabled<TSender>(this TSender This) where TSender : IReactiveObject
{
var s = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
return s.areChangeNotificationsEnabled();
}
internal static IDisposable delayChangeNotifications<TSender>(this TSender This) where TSender : IReactiveObject
{
var s = state.GetValue(This, key => (IExtensionState<IReactiveObject>)new ExtensionState<TSender>(This));
return s.delayChangeNotifications();
}
/// <summary>
/// RaiseAndSetIfChanged fully implements a Setter for a read-write
/// property on a ReactiveObject, using CallerMemberName to raise the notification
/// and the ref to the backing field to set the property.
/// </summary>
/// <typeparam name="TObj">The type of the This.</typeparam>
/// <typeparam name="TRet">The type of the return value.</typeparam>
/// <param name="This">The <see cref="ReactiveObject"/> raising the notification.</param>
/// <param name="backingField">A Reference to the backing field for this
/// property.</param>
/// <param name="newValue">The new value.</param>
/// <param name="propertyName">The name of the property, usually
/// automatically provided through the CallerMemberName attribute.</param>
/// <returns>The newly set value, normally discarded.</returns>
public static TRet RaiseAndSetIfChanged<TObj, TRet>(
this TObj This,
ref TRet backingField,
TRet newValue,
[CallerMemberName] string propertyName = null) where TObj : IReactiveObject
{
Contract.Requires(propertyName != null);
if (EqualityComparer<TRet>.Default.Equals(backingField, newValue)) {
return newValue;
}
This.raisePropertyChanging(propertyName);
backingField = newValue;
This.raisePropertyChanged(propertyName);
return newValue;
}
/// <summary>
/// Use this method in your ReactiveObject classes when creating custom
/// properties where raiseAndSetIfChanged doesn't suffice.
/// </summary>
/// <param name="This">The instance of ReactiveObject on which the property has changed.</param>
/// <param name="propertyName">
/// A string representing the name of the property that has been changed.
/// Leave <c>null</c> to let the runtime set to caller member name.
/// </param>
public static void RaisePropertyChanged<TSender>(this TSender This, [CallerMemberName] string propertyName = null)
where TSender : IReactiveObject
{
This.raisePropertyChanged(propertyName);
}
/// <summary>
/// Use this method in your ReactiveObject classes when creating custom
/// properties where raiseAndSetIfChanged doesn't suffice.
/// </summary>
/// <param name="This">The instance of ReactiveObject on which the property has changed.</param>
/// <param name="propertyName">
/// A string representing the name of the property that has been changed.
/// Leave <c>null</c> to let the runtime set to caller member name.
/// </param>
public static void RaisePropertyChanging<TSender>(this TSender This, [CallerMemberName] string propertyName = null)
where TSender : IReactiveObject
{
This.raisePropertyChanging(propertyName);
}
// Filter a list of change notifications, returning the last change for each PropertyName in original order.
static IEnumerable<IReactivePropertyChangedEventArgs<TSender>> dedup<TSender>(IList<IReactivePropertyChangedEventArgs<TSender>> batch) {
if (batch.Count <= 1) {
return batch;
}
var seen = new HashSet<string>();
var unique = new LinkedList<IReactivePropertyChangedEventArgs<TSender>>();
for (int i = batch.Count - 1; i >= 0; i--) {
if (seen.Add(batch[i].PropertyName)) {
unique.AddFirst(batch[i]);
}
}
return unique;
}
class ExtensionState<TSender> : IExtensionState<TSender> where TSender : IReactiveObject
{
long changeNotificationsSuppressed;
long changeNotificationsDelayed;
ISubject<IReactivePropertyChangedEventArgs<TSender>> changingSubject;
IObservable<IReactivePropertyChangedEventArgs<TSender>> changingObservable;
ISubject<IReactivePropertyChangedEventArgs<TSender>> changedSubject;
IObservable<IReactivePropertyChangedEventArgs<TSender>> changedObservable;
ISubject<Exception> thrownExceptions;
ISubject<Unit> startDelayNotifications;
TSender sender;
/// <summary>
/// Initializes a new instance of the <see cref="ExtensionState{TSender}"/> class.
/// </summary>
public ExtensionState(TSender sender)
{
this.sender = sender;
this.changingSubject = new Subject<IReactivePropertyChangedEventArgs<TSender>>();
this.changedSubject = new Subject<IReactivePropertyChangedEventArgs<TSender>>();
this.startDelayNotifications = new Subject<Unit>();
this.thrownExceptions = new ScheduledSubject<Exception>(Scheduler.Immediate, RxApp.DefaultExceptionHandler);
this.changedObservable = changedSubject
.Buffer(
Observable.Merge(
changedSubject.Where(_ => !areChangeNotificationsDelayed()).Select(_ => Unit.Default),
startDelayNotifications)
)
.SelectMany(batch => dedup(batch))
.Publish()
.RefCount();
this.changingObservable = changingSubject
.Buffer(
Observable.Merge(
changingSubject.Where(_ => !areChangeNotificationsDelayed()).Select(_ => Unit.Default),
startDelayNotifications)
)
.SelectMany(batch => dedup(batch))
.Publish()
.RefCount();
}
public IObservable<IReactivePropertyChangedEventArgs<TSender>> Changing {
get { return this.changingObservable; }
}
public IObservable<IReactivePropertyChangedEventArgs<TSender>> Changed {
get { return this.changedObservable; }
}
public IObservable<Exception> ThrownExceptions {
get { return thrownExceptions; }
}
public bool areChangeNotificationsEnabled()
{
return (Interlocked.Read(ref changeNotificationsSuppressed) == 0);
}
public bool areChangeNotificationsDelayed()
{
return (Interlocked.Read(ref changeNotificationsDelayed) > 0);
}
/// <summary>
/// When this method is called, an object will not fire change
/// notifications (neither traditional nor Observable notifications)
/// until the return value is disposed.
/// </summary>
/// <returns>An object that, when disposed, reenables change
/// notifications.</returns>
public IDisposable suppressChangeNotifications()
{
Interlocked.Increment(ref changeNotificationsSuppressed);
return Disposable.Create(() => Interlocked.Decrement(ref changeNotificationsSuppressed));
}
public IDisposable delayChangeNotifications()
{
if (Interlocked.Increment(ref changeNotificationsDelayed) == 1) {
startDelayNotifications.OnNext(Unit.Default);
}
return Disposable.Create(() => {
if (Interlocked.Decrement(ref changeNotificationsDelayed) == 0) {
startDelayNotifications.OnNext(Unit.Default);
};
});
}
public void raisePropertyChanging(string propertyName)
{
if (!this.areChangeNotificationsEnabled())
return;
var changing = new ReactivePropertyChangingEventArgs<TSender>(sender, propertyName);
sender.RaisePropertyChanging(changing);
this.notifyObservable(sender, changing, this.changingSubject);
}
public void raisePropertyChanged(string propertyName)
{
if (!this.areChangeNotificationsEnabled())
return;
var changed = new ReactivePropertyChangedEventArgs<TSender>(sender, propertyName);
sender.RaisePropertyChanged(changed);
this.notifyObservable(sender, changed, this.changedSubject);
}
internal void notifyObservable<T>(TSender rxObj, T item, ISubject<T> subject)
{
try {
subject.OnNext(item);
} catch (Exception ex) {
rxObj.Log().ErrorException("ReactiveObject Subscriber threw exception", ex);
thrownExceptions.OnNext(ex);
}
}
}
interface IExtensionState<out TSender> where TSender: IReactiveObject
{
IObservable<IReactivePropertyChangedEventArgs<TSender>> Changing { get; }
IObservable<IReactivePropertyChangedEventArgs<TSender>> Changed { get; }
void raisePropertyChanging(string propertyName);
void raisePropertyChanged(string propertyName);
IObservable<Exception> ThrownExceptions { get; }
bool areChangeNotificationsEnabled();
IDisposable suppressChangeNotifications();
bool areChangeNotificationsDelayed();
IDisposable delayChangeNotifications();
}
}
}