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
|
//
// Mono.Documentation/exceptions.cs
//
// Authors:
// Jonathan Pryor (jonpryor@vt.edu)
//
// (C) 2008 Novell, Inc.
//
// 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.Collections.ObjectModel;
using System.Linq;
using Mono.Cecil;
using Mono.Cecil.Cil;
using Mono.Documentation.Updater;
namespace Mono.Documentation {
[Flags]
public enum ExceptionLocations {
Member = 0x0,
Assembly = 0x1,
DependentAssemblies = 0x2,
AddedMembers = 0x4,
}
public class ExceptionSources {
internal ExceptionSources (TypeReference exception)
{
Exception = exception;
Sources = new HashSet<MemberReference> ();
}
public TypeReference Exception { get; private set; }
public HashSet<MemberReference> Sources;
}
public class ExceptionLookup {
SlashDocMemberFormatter xdoc = new SlashDocMemberFormatter ();
// xdoc(MemberRef) -> xdoc(TypeRef) -> ExceptionSource
// where ExceptionSource.Exception == xdoc(TypeRef)
Dictionary<string, Dictionary<string, ExceptionSources>> db = new Dictionary<string, Dictionary<string, ExceptionSources>> ();
ExceptionLocations locations;
public ExceptionLookup (ExceptionLocations locations)
{
this.locations = locations;
}
public IEnumerable<ExceptionSources> this [MemberReference member] {
get {
if (member == null)
throw new ArgumentNullException ("member");
var memberDef = member.Resolve ();
if (memberDef == null) {
ArrayType array = member.DeclaringType as ArrayType;
if (array != null && array.Rank > 1) {
// Multi-dimensional array; the member is runtime generated,
// doesn't "really" exist (in a form that we can resolve),
// so we can't do anything further.
return new ExceptionSources[0];
}
return new ExceptionSources[0];
//throw new NotSupportedException (string.Format (
// "Unable to resolve member {0}::{1}.",
// member.DeclaringType.FullName, member.Name));
}
string memberDecl = xdoc.GetDeclaration (member);
Dictionary<string, ExceptionSources> e;
if (!db.TryGetValue (memberDecl, out e)) {
e = new Dictionary<string, ExceptionSources> ();
db.Add (memberDecl, e);
var bodies = GetMethodBodies (member);
foreach (var body in bodies) {
if (body == null)
continue;
FillExceptions (body, e);
}
}
return e.Values;
}
}
MethodBody[] GetMethodBodies (MemberReference member)
{
if (member is MethodReference) {
return new[]{ (((MethodReference) member).Resolve ()).Body };
}
if (member is PropertyReference) {
PropertyDefinition prop = (PropertyDefinition) member;
return new[]{
prop.GetMethod != null ? prop.GetMethod.Body : null,
prop.SetMethod != null ? prop.SetMethod.Body : null,
};
}
if (member is FieldReference)
return new MethodBody[]{};
if (member is EventReference) {
EventDefinition ev = (EventDefinition) member;
return new[]{
ev.AddMethod != null ? ev.AddMethod.Body : null,
ev.InvokeMethod != null ? ev.InvokeMethod.Body : null,
ev.RemoveMethod != null ? ev.RemoveMethod.Body : null,
};
}
throw new NotSupportedException ("Unsupported member type: " + member.GetType().FullName);
}
void FillExceptions (MethodBody body, Dictionary<string, ExceptionSources> exceptions)
{
for (int i = 0; i < body.Instructions.Count; ++i) {
Instruction instruction = body.Instructions [i];
switch (instruction.OpCode.Code) {
case Code.Call:
case Code.Callvirt: {
if ((locations & ExceptionLocations.Assembly) == 0 &&
(locations & ExceptionLocations.DependentAssemblies) == 0)
break;
MemberReference memberRef = ((MemberReference) instruction.Operand);
if (((locations & ExceptionLocations.Assembly) != 0 &&
body.Method.DeclaringType.Scope.Name == memberRef.DeclaringType.Scope.Name) ||
((locations & ExceptionLocations.DependentAssemblies) != 0 &&
body.Method.DeclaringType.Scope.Name != memberRef.DeclaringType.Scope.Name)) {
IEnumerable<ExceptionSources> memberExceptions = this [memberRef];
AddExceptions (body, instruction,
memberExceptions.Select (es => es.Exception),
memberExceptions.SelectMany (es => es.Sources),
exceptions);
}
break;
}
case Code.Newobj: {
MethodReference ctor = (MethodReference) instruction.Operand;
if (IsExceptionConstructor (ctor)) {
AddExceptions (body, instruction,
new TypeReference[]{ctor.DeclaringType},
new MemberReference[]{body.Method},
exceptions);
}
break;
}
}
}
}
void AddExceptions (MethodBody body, Instruction instruction, IEnumerable<TypeReference> add, IEnumerable<MemberReference> sources,
Dictionary<string, ExceptionSources> exceptions)
{
var handlers = body.ExceptionHandlers.Cast<ExceptionHandler> ()
.Where (eh => instruction.Offset >= eh.TryStart.Offset &&
instruction.Offset <= eh.TryEnd.Offset);
foreach (var ex in add) {
if (!handlers.Any (h => IsExceptionCaught (ex, h.CatchType))) {
ExceptionSources s;
string eName = xdoc.GetDeclaration (ex);
if (!exceptions.TryGetValue (eName, out s)) {
s = new ExceptionSources (ex);
exceptions.Add (eName, s);
}
foreach (var m in sources)
s.Sources.Add (m);
}
}
}
static bool IsExceptionConstructor (MethodReference ctor)
{
return GetBases (ctor.DeclaringType)
.Any (t => t.FullName == "System.Exception");
}
bool IsExceptionCaught (TypeReference exception, TypeReference catcher)
{
return GetBases (exception).Select (e => xdoc.GetDeclaration (e))
.Union (GetBases (catcher).Select (e => xdoc.GetDeclaration (e)))
.Any ();
}
static IEnumerable<TypeReference> GetBases (TypeReference type)
{
yield return type;
TypeDefinition def = type.Resolve ();
while (def != null && def.BaseType != null) {
yield return def.BaseType;
def = def.BaseType.Resolve ();
}
}
}
}
|
