annotate Implab/Safe.cs @ 260:547a2fc0d93e v3 v3.0.6

minor fixes
author cin
date Fri, 13 Apr 2018 19:14:59 +0300
parents 7d52dc684bbd
children 9d1cca834b05
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
1 using System;
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
2 using System.Collections.Generic;
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
3 using System.Linq;
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
4 using System.Text;
51
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
5 using System.Text.RegularExpressions;
66
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
6 using System.Diagnostics;
207
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
7 using System.Collections;
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
8 using System.Runtime.CompilerServices;
251
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
9 using System.Threading.Tasks;
259
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
10 using System.Threading;
1
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
11
213
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
12 #if NET_4_5
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
13 using System.Threading.Tasks;
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
14 #endif
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
15
1
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
16 namespace Implab
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
17 {
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
18 public static class Safe
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
19 {
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
20 [MethodImpl(MethodImplOptions.AggressiveInlining)]
161
2a8466f0cb8a DFA refactoring
cin
parents: 145
diff changeset
21 public static void ArgumentAssert(bool condition, string paramName) {
2a8466f0cb8a DFA refactoring
cin
parents: 145
diff changeset
22 if (!condition)
2a8466f0cb8a DFA refactoring
cin
parents: 145
diff changeset
23 throw new ArgumentException("The parameter is invalid", paramName);
2a8466f0cb8a DFA refactoring
cin
parents: 145
diff changeset
24 }
2a8466f0cb8a DFA refactoring
cin
parents: 145
diff changeset
25
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
26 [MethodImpl(MethodImplOptions.AggressiveInlining)]
121
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
27 public static void ArgumentMatch(string value, string paramName, Regex rx) {
51
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
28 if (rx == null)
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
29 throw new ArgumentNullException("rx");
121
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
30 if (!rx.IsMatch(value))
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
31 throw new ArgumentException(String.Format("The prameter value must match {0}", rx), paramName);
51
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
32 }
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
33
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
34 [MethodImpl(MethodImplOptions.AggressiveInlining)]
121
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
35 public static void ArgumentNotEmpty(string value, string paramName) {
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
36 if (String.IsNullOrEmpty(value))
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
37 throw new ArgumentException("The parameter can't be empty", paramName);
90
efcb076407a7 code cleanup
cin
parents: 66
diff changeset
38 }
efcb076407a7 code cleanup
cin
parents: 66
diff changeset
39
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
40 [MethodImpl(MethodImplOptions.AggressiveInlining)]
121
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
41 public static void ArgumentNotEmpty<T>(T[] value, string paramName) {
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
42 if (value == null || value.Length == 0)
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
43 throw new ArgumentException("The array must be not emty", paramName);
51
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
44 }
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
45
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
46 [MethodImpl(MethodImplOptions.AggressiveInlining)]
121
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
47 public static void ArgumentNotNull(object value, string paramName) {
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
48 if (value == null)
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
49 throw new ArgumentNullException(paramName);
51
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
50 }
2c332a9c64c0 Added methods for parameter checks
cin
parents: 31
diff changeset
51
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
52 [MethodImpl(MethodImplOptions.AggressiveInlining)]
251
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
53 internal static void ArgumentGreaterEqThan(int value, int min, string paramName) {
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
54 if (value < min)
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
55 throw new ArgumentOutOfRangeException(paramName);
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
56 }
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
57
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
58 [MethodImpl(MethodImplOptions.AggressiveInlining)]
251
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
59 public static void ArgumentInRange(bool condition, string paramName) {
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
60 if (!condition)
121
62d2f1e98c4e working version of AsyncQueue and batch operations
cin
parents: 119
diff changeset
61 throw new ArgumentOutOfRangeException(paramName);
55
c0bf853aa04f Added initial JSON support
cin
parents: 51
diff changeset
62 }
c0bf853aa04f Added initial JSON support
cin
parents: 51
diff changeset
63
228
6fa235c5a760 Rewritten JsonScanner, JsonParser, fixed naming style
cin
parents: 221
diff changeset
64 [MethodImpl(MethodImplOptions.AggressiveInlining)]
177
a0ff6a0e9c44 refactoring
cin
parents: 161
diff changeset
65 public static void ArgumentOfType(object value, Type type, string paramName) {
a0ff6a0e9c44 refactoring
cin
parents: 161
diff changeset
66 if (!type.IsInstanceOfType(value))
a0ff6a0e9c44 refactoring
cin
parents: 161
diff changeset
67 throw new ArgumentException(String.Format("The parameter must be of type {0}", type), paramName);
a0ff6a0e9c44 refactoring
cin
parents: 161
diff changeset
68 }
a0ff6a0e9c44 refactoring
cin
parents: 161
diff changeset
69
128
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
70 public static void Dispose(params IDisposable[] objects) {
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
71 foreach (var d in objects)
126
f7b2b8bfbb8c minor changes
cin
parents: 121
diff changeset
72 if (d != null)
f7b2b8bfbb8c minor changes
cin
parents: 121
diff changeset
73 d.Dispose();
1
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
74 }
66
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
75
128
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
76 public static void Dispose(params object[] objects) {
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
77 foreach (var obj in objects) {
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
78 var d = obj as IDisposable;
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
79 if (d != null)
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
80 d.Dispose();
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
81 }
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
82 }
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
83
215
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
84 public static void DisposeCollection(IEnumerable<IDisposable> objects) {
207
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
85 foreach (var d in objects)
215
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
86 Dispose(d);
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
87 }
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
88
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
89 public static void DisposeCollection(IEnumerable objects) {
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
90 foreach (var d in objects)
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
91 Dispose(d);
207
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
92 }
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
93
128
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
94 public static void Dispose(object obj) {
238
bdfdba6b645b fixed unpredictable Safe.Dispose behaviour
cin
parents: 228
diff changeset
95 if (obj is IDisposable)
215
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
96 Dispose((IDisposable)obj);
238
bdfdba6b645b fixed unpredictable Safe.Dispose behaviour
cin
parents: 228
diff changeset
97
128
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
98 }
6241bff0cd64 Added Signal class a lightweight alternative to ManualResetEvent
cin
parents: 126
diff changeset
99
215
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
100 [DebuggerStepThrough]
207
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
101 public static void DispatchEvent<T>(this EventHandler<T> handler, object sender, T args) {
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
102 if (handler != null)
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
103 handler(sender, args);
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
104 }
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
105
215
fe5101083150 Fixed InteractiveListener to support OLE and clipboard.
cin
parents: 213
diff changeset
106 [DebuggerStepThrough]
207
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
107 public static void DispatchEvent(this EventHandler handler, object sender, EventArgs args) {
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
108 if (handler != null)
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
109 handler(sender, args);
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
110 }
558f34b2fb50 added Safe.DispatchEvent() a legacy equivalent for '?.Invoke()'
cin
parents: 205
diff changeset
111
66
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
112 [DebuggerStepThrough]
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
113 public static IPromise<T> Run<T>(Func<T> action) {
131
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
114 ArgumentNotNull(action, "action");
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
115
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
116 try {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
117 return Promise.Resolve(action());
131
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
118 } catch (Exception err) {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
119 return Promise.Reject<T>(err);
131
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
120 }
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
121 }
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
122
b5c2d609d71b minor changes
cin
parents: 128
diff changeset
123 [DebuggerStepThrough]
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
124 public static IPromise Run(Action action) {
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
125 ArgumentNotNull(action, "action");
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
126
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
127 try {
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
128 action();
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
129 return Promise.Resolve();
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
130 } catch (Exception err) {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
131 return Promise.Reject(err);
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
132 }
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
133 }
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
134
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
135 [DebuggerStepThrough]
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
136 public static IPromise Run(Func<IPromise> action) {
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
137 ArgumentNotNull(action, "action");
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
138
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
139 try {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
140 return action() ?? Promise.Reject(new Exception("The action returned null"));
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
141 } catch (Exception err) {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
142 return Promise.Reject(err);
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
143 }
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
144 }
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
145
213
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
146 public static void NoWait(IPromise promise) {
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
147 }
9ee78a345738 Minor code changes
cin
parents: 209
diff changeset
148
251
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
149 public static void NoWait(Task promise) {
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
150 }
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
151
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
152 public static void NoWait<T>(Task<T> promise) {
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
153 }
7c7e9ad6fe4a Prerelease version of RunnableComponent
cin
parents: 248
diff changeset
154
259
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
155 public static void Noop() {
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
156 }
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
157
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
158 public static void Noop(CancellationToken ct) {
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
159 ct.ThrowIfCancellationRequested();
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
160 }
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
161
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
162 public static Task CreateTask() {
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
163 return new Task(Noop);
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
164 }
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
165
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
166 public static Task CreateTask(CancellationToken ct) {
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
167 return new Task(Noop, ct);
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
168 }
7d52dc684bbd PollingComponent: implemented correct stopping
cin
parents: 251
diff changeset
169
203
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
170 [DebuggerStepThrough]
4d9830a9bbb8 Added 'Fail' method to RunnableComponent which allows component to move from
cin
parents: 177
diff changeset
171 public static IPromise<T> Run<T>(Func<IPromise<T>> action) {
66
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
172 ArgumentNotNull(action, "action");
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
173
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
174 try {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
175 return action() ?? Promise.Reject<T>(new Exception("The action returned null"));
66
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
176 } catch (Exception err) {
248
5cb4826c2c2a Added awaiters to promises
cin
parents: 238
diff changeset
177 return Promise.Reject<T>(err);
66
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
178 }
790e8a997d30 Refactoring
cin
parents: 55
diff changeset
179 }
209
a867536c68fc Bound promise to CancellationToken
cin
parents: 207
diff changeset
180
1
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
181 }
6fb3b01ee971 Added utility class for safe disposing methods.
cin
parents:
diff changeset
182 }