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
|
/* ****************************************************************************
*
* Copyright (c) Microsoft Corporation.
*
* This source code is subject to terms and conditions of the Microsoft Public License. A
* copy of the license can be found in the License.html file at the root of this distribution. If
* you cannot locate the Microsoft Public License, please send an email to
* dlr@microsoft.com. By using this source code in any fashion, you are agreeing to be bound
* by the terms of the Microsoft Public License.
*
* You must not remove this notice, or any other, from this software.
*
*
* ***************************************************************************/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq.Expressions;
using System.Diagnostics;
namespace Microsoft.Scripting.Utils {
public static class ContractUtils {
public static void Requires(bool precondition) {
if (!precondition) {
throw new ArgumentException(Strings.MethodPreconditionViolated);
}
}
public static void Requires(bool precondition, string paramName) {
Assert.NotEmpty(paramName);
if (!precondition) {
throw new ArgumentException(Strings.InvalidArgumentValue, paramName);
}
}
public static void Requires(bool precondition, string paramName, string message) {
Assert.NotEmpty(paramName);
if (!precondition) {
throw new ArgumentException(message, paramName);
}
}
public static void RequiresNotNull(object value, string paramName) {
Assert.NotEmpty(paramName);
if (value == null) {
throw new ArgumentNullException(paramName);
}
}
public static void RequiresNotEmpty(string str, string paramName) {
RequiresNotNull(str, paramName);
if (str.Length == 0) {
throw new ArgumentException(Strings.NonEmptyStringRequired, paramName);
}
}
public static void RequiresNotEmpty<T>(ICollection<T> collection, string paramName) {
RequiresNotNull(collection, paramName);
if (collection.Count == 0) {
throw new ArgumentException(Strings.NonEmptyCollectionRequired, paramName);
}
}
/// <summary>
/// Requires the specified index to point inside the array.
/// </summary>
/// <exception cref="ArgumentNullException">Array is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException">Index is outside the array.</exception>
public static void RequiresArrayIndex<T>(IList<T> array, int index, string indexName) {
RequiresArrayIndex(array.Count, index, indexName);
}
/// <summary>
/// Requires the specified index to point inside the array.
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">Index is outside the array.</exception>
public static void RequiresArrayIndex(int arraySize, int index, string indexName) {
Assert.NotEmpty(indexName);
Debug.Assert(arraySize >= 0);
if (index < 0 || index >= arraySize) throw new ArgumentOutOfRangeException(indexName);
}
/// <summary>
/// Requires the specified index to point inside the array or at the end
/// </summary>
/// <exception cref="ArgumentNullException">Array is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException">Index is outside the array.</exception>
public static void RequiresArrayInsertIndex<T>(IList<T> array, int index, string indexName) {
RequiresArrayInsertIndex(array.Count, index, indexName);
}
/// <summary>
/// Requires the specified index to point inside the array or at the end
/// </summary>
/// <exception cref="ArgumentNullException">Array is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException">Index is outside the array.</exception>
public static void RequiresArrayInsertIndex(int arraySize, int index, string indexName) {
Assert.NotEmpty(indexName);
Debug.Assert(arraySize >= 0);
if (index < 0 || index > arraySize) throw new ArgumentOutOfRangeException(indexName);
}
/// <summary>
/// Requires the range [offset, offset + count] to be a subset of [0, array.Count].
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">Offset or count are out of range.</exception>
public static void RequiresArrayRange<T>(IList<T> array, int offset, int count, string offsetName, string countName) {
Assert.NotNull(array);
RequiresArrayRange(array.Count, offset, count, offsetName, countName);
}
/// <summary>
/// Requires the range [offset, offset + count] to be a subset of [0, array.Count].
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">Offset or count are out of range.</exception>
public static void RequiresArrayRange(int arraySize, int offset, int count, string offsetName, string countName) {
Assert.NotEmpty(offsetName);
Assert.NotEmpty(countName);
Debug.Assert(arraySize >= 0);
if (count < 0) throw new ArgumentOutOfRangeException(countName);
if (offset < 0 || arraySize - offset < count) throw new ArgumentOutOfRangeException(offsetName);
}
/// <summary>
/// Requires the range [offset, offset + count] to be a subset of [0, array.Count].
/// </summary>
/// <exception cref="ArgumentNullException">Array is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException">Offset or count are out of range.</exception>
public static void RequiresListRange(IList array, int offset, int count, string offsetName, string countName) {
Assert.NotEmpty(offsetName);
Assert.NotEmpty(countName);
Assert.NotNull(array);
if (count < 0) throw new ArgumentOutOfRangeException(countName);
if (offset < 0 || array.Count - offset < count) throw new ArgumentOutOfRangeException(offsetName);
}
/// <summary>
/// Requires the range [offset, offset + count] to be a subset of [0, array.Count].
/// </summary>
/// <exception cref="ArgumentNullException">String is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException">Offset or count are out of range.</exception>
public static void RequiresArrayRange(string str, int offset, int count, string offsetName, string countName) {
Assert.NotEmpty(offsetName);
Assert.NotEmpty(countName);
Assert.NotNull(str);
if (count < 0) throw new ArgumentOutOfRangeException(countName);
if (offset < 0 || str.Length - offset < count) throw new ArgumentOutOfRangeException(offsetName);
}
/// <summary>
/// Requires the array and all its items to be non-null.
/// </summary>
public static void RequiresNotNullItems<T>(IList<T> array, string arrayName) {
Assert.NotNull(arrayName);
RequiresNotNull(array, arrayName);
for (int i = 0; i < array.Count; i++) {
if (array[i] == null) {
throw ExceptionUtils.MakeArgumentItemNullException(i, arrayName);
}
}
}
/// <summary>
/// Requires the enumerable collection and all its items to be non-null.
/// </summary>
public static void RequiresNotNullItems<T>(IEnumerable<T> collection, string collectionName) {
Assert.NotNull(collectionName);
RequiresNotNull(collection, collectionName);
int i = 0;
foreach (var item in collection) {
if (item == null) {
throw ExceptionUtils.MakeArgumentItemNullException(i, collectionName);
}
i++;
}
}
[Conditional("FALSE")]
public static void Invariant(bool condition) {
Debug.Assert(condition);
}
[Conditional("FALSE")]
public static void Invariant(bool condition, string message) {
Debug.Assert(condition, message);
}
[Conditional("FALSE")]
public static void Ensures(bool condition) {
// nop
}
[Conditional("FALSE")]
public static void Ensures(bool condition, string message) {
// nop
}
public static T Result<T>() {
return default(T);
}
public static T Parameter<T>(out T value) {
value = default(T);
return value;
}
public static T Old<T>(T value) {
return value;
}
}
}
|
