File: ContractNodes.cs

package info (click to toggle)
mono 6.8.0.105%2Bdfsg-3.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,284,512 kB
  • sloc: cs: 11,172,132; xml: 2,850,069; ansic: 671,653; cpp: 122,091; perl: 59,366; javascript: 30,841; asm: 22,168; makefile: 20,093; sh: 15,020; python: 4,827; pascal: 925; sql: 859; sed: 16; php: 1
file content (221 lines) | stat: -rw-r--r-- 8,105 bytes parent folder | download | duplicates (9)
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
// 
// ContractNodes.cs
// 
// Authors:
// 	Alexander Chebaturkin (chebaturkin@gmail.com)
// 
// Copyright (C) 2011 Alexander Chebaturkin
// 
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//  
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using Mono.CodeContracts.Static.AST;

namespace Mono.CodeContracts.Static.ContractExtraction {
	class ContractNodes {
		public static readonly string ContractNamespace = "System.Diagnostics.Contracts";
		public static readonly string ContractClassName = "Contract";
		public static readonly string RequiresName = "Requires";
		public static readonly string EnsuresName = "Ensures";
		public static readonly string AssertName = "Assert";
		public static readonly string AssumeName = "Assume";
		public static readonly string EndContractBlockName = "EndContractBlock";

		[RepresentationFor ("Contract.Assert(bool)")]
		public readonly Method AssertMethod;

		[RepresentationFor ("Contract.Assert(bool, string)")]
		public readonly Method AssertWithMessageMethod;

		[RepresentationFor ("Contract.Assume(bool)")]
		public readonly Method AssumeMethod;

		[RepresentationFor ("Contract.Assume(bool, string)")]
		public readonly Method AssumeWithMessageMethod;

		[RepresentationFor ("System.Diagnostics.Contracts.Contract")]
		public readonly Class ContractClass;

		[RepresentationFor ("Contract.EndContractBlock()")]
		public readonly Method EndContractBlock;

		[RepresentationFor ("Contract.Ensures(bool)")]
		public readonly Method EnsuresMethod;

		[RepresentationFor ("Contract.Ensures(bool, string)")]
		public readonly Method EnsuresWithMessageMethod;

		[RepresentationFor ("Contract.Requires(bool)")]
		public readonly Method RequiresMethod;

		[RepresentationFor ("Contract.Requires(bool, string)")]
		public readonly Method RequiresWithMessageMethod;

		private ContractNodes (AssemblyNode assembly, Action<string> errorHandler)
		{
			CoreSystemTypes.ModuleDefinition = assembly.Modules.First ().Definition;
			if (errorHandler != null)
				ErrorFound += errorHandler;
			this.ContractClass = assembly.GetType (ContractNamespace, ContractClassName) as Class;
			if (this.ContractClass == null)
				return;


			IEnumerable<Method> methods = this.ContractClass.GetMethods (RequiresName, CoreSystemTypes.Instance.TypeBoolean);
			foreach (Method method in methods) {
				if (method.GenericParameters == null || method.GenericParameters.Count == 0)
					this.RequiresMethod = method;
			}

			if (this.RequiresMethod == null) {
				this.ContractClass = null;
				return;
			}

			methods = this.ContractClass.GetMethods (RequiresName, CoreSystemTypes.Instance.TypeBoolean, CoreSystemTypes.Instance.TypeString);
			foreach (Method method in methods) {
				if (method.GenericParameters == null || method.GenericParameters.Count == 0)
					this.RequiresWithMessageMethod = method;
			}
			this.EnsuresMethod = this.ContractClass.GetMethod (EnsuresName, CoreSystemTypes.Instance.TypeBoolean);
			this.EnsuresWithMessageMethod = this.ContractClass.GetMethod (EnsuresName,
			                                                              CoreSystemTypes.Instance.TypeBoolean, CoreSystemTypes.Instance.TypeString);

			this.AssertMethod = this.ContractClass.GetMethod (AssertName, CoreSystemTypes.Instance.TypeBoolean);
			this.AssertWithMessageMethod = this.ContractClass.GetMethod (AssertName,
			                                                             CoreSystemTypes.Instance.TypeBoolean, CoreSystemTypes.Instance.TypeString);

			this.AssumeMethod = this.ContractClass.GetMethod (AssumeName, CoreSystemTypes.Instance.TypeBoolean);
			this.AssumeWithMessageMethod = this.ContractClass.GetMethod (AssumeName,
			                                                             CoreSystemTypes.Instance.TypeBoolean, CoreSystemTypes.Instance.TypeString);

			this.EndContractBlock = this.ContractClass.GetMethod (EndContractBlockName);

			foreach (FieldInfo fieldInfo in typeof (ContractNodes).GetFields ()) {
				if (fieldInfo.GetValue (this) != null)
					continue;

				string runtimeName = null;
				bool isRequired = false;
				object[] attributes = fieldInfo.GetCustomAttributes (typeof (RepresentationForAttribute), false);
				foreach (object attribute in attributes) {
					var representationForAttribute = attribute as RepresentationForAttribute;
					if (representationForAttribute != null) {
						runtimeName = representationForAttribute.RuntimeName;
						isRequired = representationForAttribute.IsRequired;
						break;
					}
				}
				if (isRequired) {
					string message = string.Format ("Could not find contract node for '{0}'", fieldInfo.Name);
					if (runtimeName != null)
						message = string.Format ("Could not find the method/type '{0}'", runtimeName);

					FireErrorFound (message);
					ClearFields ();
				}
			}
		}

		public static ContractNodes GetContractNodes (AssemblyNode assembly, Action<string> errorHandler)
		{
			var contractNodes = new ContractNodes (assembly, errorHandler);
			if (contractNodes.ContractClass != null)
				return contractNodes;
			return null;
		}

		private void ClearFields ()
		{
			foreach (FieldInfo fieldInfo in typeof (ContractNodes).GetFields ()) {
				object[] customAttributes = fieldInfo.GetCustomAttributes (typeof (RepresentationForAttribute), false);
				if (customAttributes.Length == 1)
					fieldInfo.SetValue (this, null);
			}
		}

		public event Action<string> ErrorFound;

		private void FireErrorFound (string message)
		{
			if (ErrorFound == null)
				throw new InvalidOperationException (message);

			ErrorFound (message);
		}

		public Method IsContractCall (Statement s)
		{
			Method m = HelperMethods.IsMethodCall (s);
			if (IsContractMethod (m))
				return m;

			return null;
		}

		public bool IsContractMethod (Method method)
		{
			if (method == null)
				return false;
			if (IsPlainPrecondition (method) || IsPostCondition (method) || IsEndContractBlock (method))
				return true;

			return false;
		}

		public bool IsPostCondition (Method method)
		{
			TypeNode genericArgument;
			return IsContractMethod (EnsuresName, method, out genericArgument) && genericArgument == null;
		}

		public bool IsPlainPrecondition (Method method)
		{
			TypeNode genericArgument;
			return IsContractMethod (RequiresName, method, out genericArgument);
		}

		private bool IsContractMethod (string methodName, Method m, out TypeNode genericArgument)
		{
			genericArgument = null;
			if (m == null)
				return false;
			if (m.HasGenericParameters) {
				if (m.GenericParameters == null || m.GenericParameters.Count != 1)
					return false;
				genericArgument = m.GenericParameters [0];
			}

			return m.Name != null && m.Name == methodName &&
			       (m.DeclaringType.Equals (this.ContractClass)
			        || (m.Parameters != null && m.Parameters.Count == 3 && m.DeclaringType != null && m.DeclaringType.Name != ContractClassName));
		}

		public bool IsEndContractBlock (Method method)
		{
			TypeNode dummy;
			return IsContractMethod (EndContractBlockName, method, out dummy);
		}
	}
}