annotate Implab/Safe.cs @ 249:d82909310094 v3

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