-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
SnackbarMessageQueue.cs
456 lines (389 loc) · 18.7 KB
/
SnackbarMessageQueue.cs
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Input;
using System.Windows.Threading;
namespace MaterialDesignThemes.Wpf
{
public class SnackbarMessageQueue : ISnackbarMessageQueue, IDisposable
{
private readonly TimeSpan _messageDuration;
private readonly HashSet<Snackbar> _pairedSnackbars = new HashSet<Snackbar>();
private readonly LinkedList<SnackbarMessageQueueItem> _snackbarMessages = new LinkedList<SnackbarMessageQueueItem>();
private readonly ManualResetEvent _disposedEvent = new ManualResetEvent(false);
private readonly ManualResetEvent _pausedEvent = new ManualResetEvent(false);
private readonly ManualResetEvent _messageWaitingEvent = new ManualResetEvent(false);
private Tuple<SnackbarMessageQueueItem, DateTime> _latestShownItem;
private int _pauseCounter;
private bool _isDisposed;
#region private class MouseNotOverManagedWaitHandle : IDisposable
private class MouseNotOverManagedWaitHandle : IDisposable
{
private readonly ManualResetEvent _waitHandle;
private readonly ManualResetEvent _disposedWaitHandle = new ManualResetEvent(false);
private Action _cleanUp;
private bool _isWaitHandleDisposed;
private readonly object _waitHandleGate = new object();
public MouseNotOverManagedWaitHandle(UIElement uiElement)
{
if (uiElement == null) throw new ArgumentNullException(nameof(uiElement));
_waitHandle = new ManualResetEvent(!uiElement.IsMouseOver);
uiElement.MouseEnter += UiElementOnMouseEnter;
uiElement.MouseLeave += UiElementOnMouseLeave;
_cleanUp = () =>
{
uiElement.MouseEnter -= UiElementOnMouseEnter;
uiElement.MouseLeave -= UiElementOnMouseLeave;
lock (_waitHandleGate)
{
_waitHandle.Dispose();
_isWaitHandleDisposed = true;
}
_disposedWaitHandle.Set();
_disposedWaitHandle.Dispose();
_cleanUp = () => { };
};
}
public WaitHandle WaitHandle => _waitHandle;
private void UiElementOnMouseLeave(object sender, MouseEventArgs mouseEventArgs)
{
Task.Factory.StartNew(() =>
{
try
{
_disposedWaitHandle.WaitOne(TimeSpan.FromSeconds(2));
}
catch (ObjectDisposedException)
{
/* we are we suppresing this?
* as we have switched out wait onto another thread, so we don't block the UI thread, the
* _cleanUp/Dispose() action might also happen, and the _disposedWaitHandle might get disposed
* just before we WaitOne. We wond add a lock in the _cleanUp because it might block for 2 seconds.
* We could use a Monitor.TryEnter in _cleanUp and run clean up after but oh my gosh it's just getting
* too complicated for this use case, so for the rare times this happens, we can swallow safely
*/
}
}).ContinueWith(t =>
{
if (((UIElement) sender).IsMouseOver) return;
lock (_waitHandleGate)
{
if (!_isWaitHandleDisposed)
_waitHandle.Set();
}
}, TaskScheduler.FromCurrentSynchronizationContext());
}
private void UiElementOnMouseEnter(object sender, MouseEventArgs mouseEventArgs)
{
_waitHandle.Reset();
}
public void Dispose()
{
_cleanUp();
}
}
#endregion
#region private class DurationMonitor
private class DurationMonitor
{
private DateTime _completionTime;
private DurationMonitor(
TimeSpan minimumDuration,
WaitHandle pausedWaitHandle,
EventWaitHandle signalWhenDurationPassedWaitHandle,
WaitHandle ceaseWaitHandle)
{
if (pausedWaitHandle == null) throw new ArgumentNullException(nameof(pausedWaitHandle));
if (signalWhenDurationPassedWaitHandle == null)
throw new ArgumentNullException(nameof(signalWhenDurationPassedWaitHandle));
if (ceaseWaitHandle == null) throw new ArgumentNullException(nameof(ceaseWaitHandle));
_completionTime = DateTime.Now.Add(minimumDuration);
//this keeps the event waiting simpler, rather that actually watching play -> pause -> play -> pause etc
var granularity = TimeSpan.FromMilliseconds(200);
Task.Factory.StartNew(() =>
{
//keep upping the completion time in case it's paused...
while (DateTime.Now < _completionTime && !ceaseWaitHandle.WaitOne(granularity))
{
if (pausedWaitHandle.WaitOne(TimeSpan.Zero))
{
_completionTime = _completionTime.Add(granularity);
}
}
if (DateTime.Now >= _completionTime)
signalWhenDurationPassedWaitHandle.Set();
});
}
public static DurationMonitor Start(TimeSpan minimumDuration,
WaitHandle pausedWaitHandle,
EventWaitHandle signalWhenDurationPassedWaitHandle,
WaitHandle ceaseWaitHandle)
{
return new DurationMonitor(minimumDuration, pausedWaitHandle, signalWhenDurationPassedWaitHandle,
ceaseWaitHandle);
}
}
#endregion
public SnackbarMessageQueue() : this(TimeSpan.FromSeconds(3))
{
}
public SnackbarMessageQueue(TimeSpan messageDuration)
{
_messageDuration = messageDuration;
Task.Factory.StartNew(PumpAsync);
}
//oh if only I had Disposable.Create in this lib :) tempted to copy it in like dragabalz,
//but this is an internal method so no one will know my direty Action disposer...
internal Action Pair(Snackbar snackbar)
{
if (snackbar == null) throw new ArgumentNullException(nameof(snackbar));
_pairedSnackbars.Add(snackbar);
return () => _pairedSnackbars.Remove(snackbar);
}
internal Action Pause()
{
if (_isDisposed) return () => { };
if (Interlocked.Increment(ref _pauseCounter) == 1)
_pausedEvent.Set();
return () =>
{
if (Interlocked.Decrement(ref _pauseCounter) == 0)
_pausedEvent.Reset();
};
}
/// <summary>
/// Gets or sets a value that indicates whether this message queue displays messages without discarding duplicates.
/// True to show every message even if there are duplicates.
/// </summary>
public bool IgnoreDuplicate { get; set; }
public void Enqueue(object content)
{
Enqueue(content, false);
}
public void Enqueue(object content, bool neverConsiderToBeDuplicate)
{
if (content == null) throw new ArgumentNullException(nameof(content));
Enqueue(content, null, null, null, false, neverConsiderToBeDuplicate);
}
public void Enqueue(object content, object actionContent, Action actionHandler)
{
Enqueue(content, actionContent, actionHandler, false);
}
public void Enqueue(object content, object actionContent, Action actionHandler, bool promote)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (actionContent == null) throw new ArgumentNullException(nameof(actionContent));
if (actionHandler == null) throw new ArgumentNullException(nameof(actionHandler));
Enqueue(content, actionContent, _ => actionHandler(), promote, false, false);
}
public void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler,
TArgument actionArgument)
{
Enqueue(content, actionContent, actionHandler, actionArgument, false, false);
}
public void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler,
TArgument actionArgument, bool promote) =>
Enqueue(content, actionContent, actionHandler, actionArgument, promote, promote);
public void Enqueue<TArgument>(object content, object actionContent, Action<TArgument> actionHandler,
TArgument actionArgument, bool promote, bool neverConsiderToBeDuplicate, TimeSpan? durationOverride = null)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (actionContent == null ^ actionHandler == null)
{
throw new ArgumentException("All action arguments must be provided if any are provided.",
actionContent != null ? nameof(actionContent) : nameof(actionHandler));
}
Action<object> handler = actionHandler != null
? new Action<object>(argument => actionHandler((TArgument)argument))
: null;
Enqueue(content, actionContent, handler, actionArgument, promote, neverConsiderToBeDuplicate);
}
public void Enqueue(object content, object actionContent, Action<object> actionHandler,
object actionArgument, bool promote, bool neverConsiderToBeDuplicate, TimeSpan? durationOverride = null)
{
if (content == null) throw new ArgumentNullException(nameof(content));
if (actionContent == null ^ actionHandler == null)
{
throw new ArgumentException("All action arguments must be provided if any are provided.",
actionContent != null ? nameof(actionContent) : nameof(actionHandler));
}
var snackbarMessageQueueItem = new SnackbarMessageQueueItem(content, durationOverride ?? _messageDuration,
actionContent, actionHandler, actionArgument, promote, neverConsiderToBeDuplicate);
if (promote)
InsertAsLastNotPromotedNode(snackbarMessageQueueItem);
else
_snackbarMessages.AddLast(snackbarMessageQueueItem);
_messageWaitingEvent.Set();
}
private void InsertAsLastNotPromotedNode(SnackbarMessageQueueItem snackbarMessageQueueItem)
{
var node = _snackbarMessages.First;
while (node != null)
{
if (!node.Value.IsPromoted)
{
_snackbarMessages.AddBefore(node, snackbarMessageQueueItem);
return;
}
node = node.Next;
}
_snackbarMessages.AddLast(snackbarMessageQueueItem);
}
private async void PumpAsync()
{
while (!_isDisposed)
{
var eventId = WaitHandle.WaitAny(new WaitHandle[] { _disposedEvent, _messageWaitingEvent });
if (eventId == 0) continue;
var exemplar = _pairedSnackbars.FirstOrDefault();
if (exemplar == null)
{
Trace.TraceWarning(
"A snackbar message as waiting, but no Snackbar instances are assigned to the message queue.");
_disposedEvent.WaitOne(TimeSpan.FromSeconds(1));
continue;
}
//find a target
var snackbar = await FindSnackbar(exemplar.Dispatcher);
//show message
if (snackbar != null)
{
var message = _snackbarMessages.First.Value;
_snackbarMessages.RemoveFirst();
if (_latestShownItem == null
|| IgnoreDuplicate
|| message.IgnoreDuplicate
|| !Equals(_latestShownItem.Item1.Content, message.Content)
|| !Equals(_latestShownItem.Item1.ActionContent, message.ActionContent)
|| _latestShownItem.Item2 <= DateTime.Now.Subtract(_latestShownItem.Item1.Duration))
{
await ShowAsync(snackbar, message);
_latestShownItem = new Tuple<SnackbarMessageQueueItem, DateTime>(message, DateTime.Now);
}
}
else
{
//no snackbar could be found, take a break
_disposedEvent.WaitOne(TimeSpan.FromSeconds(1));
}
if (_snackbarMessages.Count > 0)
_messageWaitingEvent.Set();
else
_messageWaitingEvent.Reset();
}
}
private DispatcherOperation<Snackbar> FindSnackbar(Dispatcher dispatcher)
{
return dispatcher.InvokeAsync(() =>
{
return _pairedSnackbars.FirstOrDefault(sb =>
{
if (!sb.IsLoaded || sb.Visibility != Visibility.Visible) return false;
var window = Window.GetWindow(sb);
return window?.WindowState != WindowState.Minimized;
});
});
}
private async Task ShowAsync(Snackbar snackbar, SnackbarMessageQueueItem messageQueueItem)
{
await Task.Run(async () =>
{
//create and show the message, setting up all the handles we need to wait on
var actionClickWaitHandle = new ManualResetEvent(false);
var mouseNotOverManagedWaitHandle =
await
snackbar.Dispatcher.InvokeAsync(
() => CreateAndShowMessage(snackbar, messageQueueItem, actionClickWaitHandle));
var durationPassedWaitHandle = new ManualResetEvent(false);
DurationMonitor.Start(messageQueueItem.Duration.Add(snackbar.ActivateStoryboardDuration),
_pausedEvent, durationPassedWaitHandle, _disposedEvent);
//wait until time span completed (including pauses and mouse overs), or the action is clicked
await WaitForCompletionAsync(mouseNotOverManagedWaitHandle, durationPassedWaitHandle, actionClickWaitHandle);
//close message on snackbar
await
snackbar.Dispatcher.InvokeAsync(
() => snackbar.SetCurrentValue(Snackbar.IsActiveProperty, false));
//we could wait for the animation event, but just doing
//this for now...at least it is prevent extra call back hell
_disposedEvent.WaitOne(snackbar.DeactivateStoryboardDuration);
//remove message on snackbar
await snackbar.Dispatcher.InvokeAsync(
() => snackbar.SetCurrentValue(Snackbar.MessageProperty, null));
mouseNotOverManagedWaitHandle.Dispose();
durationPassedWaitHandle.Dispose();
})
.ContinueWith(t =>
{
if (t.Exception == null) return;
var exc = t.Exception.InnerExceptions.FirstOrDefault() ?? t.Exception;
Trace.WriteLine("Error occured whilst showing Snackbar, exception will be rethrown.");
Trace.WriteLine($"{exc.Message} ({exc.GetType().FullName})");
Trace.WriteLine(exc.StackTrace);
throw t.Exception;
});
}
private static MouseNotOverManagedWaitHandle CreateAndShowMessage(UIElement snackbar,
SnackbarMessageQueueItem messageQueueItem, EventWaitHandle actionClickWaitHandle)
{
var clickCount = 0;
var snackbarMessage = Create(messageQueueItem);
snackbarMessage.ActionClick += (sender, args) =>
{
if (++clickCount == 1)
DoActionCallback(messageQueueItem);
actionClickWaitHandle.Set();
};
snackbar.SetCurrentValue(Snackbar.MessageProperty, snackbarMessage);
snackbar.SetCurrentValue(Snackbar.IsActiveProperty, true);
return new MouseNotOverManagedWaitHandle(snackbar);
}
private static async Task WaitForCompletionAsync(
MouseNotOverManagedWaitHandle mouseNotOverManagedWaitHandle,
WaitHandle durationPassedWaitHandle, WaitHandle actionClickWaitHandle)
{
await Task.WhenAny(
Task.Factory.StartNew(() =>
{
WaitHandle.WaitAll(new[]
{
mouseNotOverManagedWaitHandle.WaitHandle,
durationPassedWaitHandle
});
}),
Task.Factory.StartNew(actionClickWaitHandle.WaitOne));
}
private static void DoActionCallback(SnackbarMessageQueueItem messageQueueItem)
{
try
{
messageQueueItem.ActionHandler(messageQueueItem.ActionArgument);
}
catch (Exception exc)
{
Trace.WriteLine("Error during SnackbarMessageQueue message action callback, exception will be rethrown.");
Trace.WriteLine($"{exc.Message} ({exc.GetType().FullName})");
Trace.WriteLine(exc.StackTrace);
throw;
}
}
private static SnackbarMessage Create(SnackbarMessageQueueItem messageQueueItem)
{
return new SnackbarMessage
{
Content = messageQueueItem.Content,
ActionContent = messageQueueItem.ActionContent
};
}
public void Dispose()
{
_isDisposed = true;
_disposedEvent.Set();
_disposedEvent.Dispose();
_pausedEvent.Dispose();
}
}
}