forked from reactiveui/ReactiveUI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathReactiveObject.cs
More file actions
270 lines (232 loc) · 10.2 KB
/
ReactiveObject.cs
File metadata and controls
270 lines (232 loc) · 10.2 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
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.Diagnostics.Contracts;
using System.Reactive.Disposables;
using System.Linq;
using System.Linq.Expressions;
using System.Reactive.Subjects;
using System.Reflection;
using System.Runtime.Serialization;
using System.Threading;
using System.Reactive.Concurrency;
using System.Runtime.CompilerServices;
namespace ReactiveUI
{
/// <summary>
/// ReactiveObject is the base object for ViewModel classes, and it
/// implements INotifyPropertyChanged. In addition, ReactiveObject provides
/// Changing and Changed Observables to monitor object changes.
/// </summary>
[DataContract]
public class ReactiveObject : IReactiveNotifyPropertyChanged, IHandleObservableErrors
{
[field: IgnoreDataMember]
bool rxObjectsSetup = false;
[field:IgnoreDataMember]
public event PropertyChangingEventHandler PropertyChanging;
[field:IgnoreDataMember]
public event PropertyChangedEventHandler PropertyChanged;
/// <summary>
/// Represents an Observable that fires *before* a property is about to
/// be changed.
/// </summary>
[IgnoreDataMember]
public IObservable<IObservedChange<object, object>> Changing {
get { return changingSubject; }
}
/// <summary>
/// Represents an Observable that fires *after* a property has changed.
/// </summary>
[IgnoreDataMember]
public IObservable<IObservedChange<object, object>> Changed {
get { return changedSubject; }
}
[IgnoreDataMember]
protected Lazy<PropertyInfo[]> allPublicProperties;
[IgnoreDataMember]
Subject<IObservedChange<object, object>> changingSubject;
[IgnoreDataMember]
Subject<IObservedChange<object, object>> changedSubject;
[IgnoreDataMember]
long changeNotificationsSuppressed = 0;
[IgnoreDataMember]
readonly ScheduledSubject<Exception> thrownExceptions = new ScheduledSubject<Exception>(Scheduler.Immediate, RxApp.DefaultExceptionHandler);
[IgnoreDataMember]
public IObservable<Exception> ThrownExceptions { get { return thrownExceptions; } }
protected ReactiveObject()
{
setupRxObj();
}
[OnDeserialized]
void setupRxObj(StreamingContext sc) { setupRxObj(); }
void setupRxObj()
{
if (rxObjectsSetup) return;
changingSubject = new Subject<IObservedChange<object, object>>();
changedSubject = new Subject<IObservedChange<object, object>>();
allPublicProperties = new Lazy<PropertyInfo[]>(() =>
GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance).ToArray());
rxObjectsSetup = true;
}
/// <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));
}
protected internal void raisePropertyChanging(string propertyName)
{
Contract.Requires(propertyName != null);
if (!areChangeNotificationsEnabled || changingSubject == null)
return;
var handler = this.PropertyChanging;
if (handler != null) {
var e = new PropertyChangingEventArgs(propertyName);
handler(this, e);
}
notifyObservable(new ObservedChange<object, object>() {
PropertyName = propertyName, Sender = this, Value = null
}, changingSubject);
}
protected internal void raisePropertyChanged(string propertyName)
{
Contract.Requires(propertyName != null);
this.Log().Debug("{0:X}.{1} changed", this.GetHashCode(), propertyName);
if (!areChangeNotificationsEnabled || changedSubject == null) {
this.Log().Debug("Suppressed change");
return;
}
var handler = this.PropertyChanged;
if (handler != null) {
var e = new PropertyChangedEventArgs(propertyName);
handler(this, e);
}
notifyObservable(new ObservedChange<object, object>() {
PropertyName = propertyName, Sender = this, Value = null
}, changedSubject);
}
protected bool areChangeNotificationsEnabled {
get {
return (Interlocked.Read(ref changeNotificationsSuppressed) == 0);
}
}
internal void notifyObservable<T>(T item, Subject<T> subject)
{
try {
subject.OnNext(item);
} catch (Exception ex) {
this.Log().ErrorException("ReactiveObject Subscriber threw exception", ex);
thrownExceptions.OnNext(ex);
}
}
}
public static class ReactiveObjectExpressionMixin
{
/// <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 : ReactiveObject
{
Contract.Requires(This != null);
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<TObj>(
this TObj This,
[CallerMemberName] string propertyName = null)
where TObj : ReactiveObject
{
This.raisePropertyChanged(propertyName);
}
}
public static class ReactiveObjectTestMixin
{
/// <summary>
/// RaisePropertyChanging is a helper method intended for test / mock
/// scenarios to manually fake a property change.
/// </summary>
/// <param name="target">The ReactiveObject to invoke
/// raisePropertyChanging on.</param>
/// <param name="property">The property that will be faking a change.</param>
public static void RaisePropertyChanging(ReactiveObject target, string property)
{
target.raisePropertyChanging(property);
}
/// <summary>
/// RaisePropertyChanging is a helper method intended for test / mock
/// scenarios to manually fake a property change.
/// </summary>
/// <param name="target">The ReactiveObject to invoke
/// raisePropertyChanging on.</param>
/// <param name="property">The property that will be faking a change.</param>
public static void RaisePropertyChanging<TSender, TValue>(TSender target, Expression<Func<TSender, TValue>> property)
where TSender : ReactiveObject
{
RaisePropertyChanging(target, Reflection.SimpleExpressionToPropertyName(property));
}
/// <summary>
/// RaisePropertyChanged is a helper method intended for test / mock
/// scenarios to manually fake a property change.
/// </summary>
/// <param name="target">The ReactiveObject to invoke
/// raisePropertyChanging on.</param>
/// <param name="property">The property that will be faking a change.</param>
public static void RaisePropertyChanged(ReactiveObject target, string property)
{
target.raisePropertyChanged(property);
}
/// <summary>
/// RaisePropertyChanged is a helper method intended for test / mock
/// scenarios to manually fake a property change.
/// </summary>
/// <param name="target">The ReactiveObject to invoke
/// raisePropertyChanging on.</param>
/// <param name="property">The property that will be faking a change.</param>
public static void RaisePropertyChanged<TSender, TValue>(TSender target, Expression<Func<TSender, TValue>> property)
where TSender : ReactiveObject
{
RaisePropertyChanged(target, Reflection.SimpleExpressionToPropertyName(property));
}
}
}
// vim: tw=120 ts=4 sw=4 et :