annotate Implab/Safe.cs @ 255:b00441e04738 v3

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