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
|
//
// Gendarme.Framework.Engines.SuppressMessageEngine
//
// Authors:
// Sebastien Pouliot <sebastien@ximian.com>
//
// Copyright (C) 2010 Novell, Inc (http://www.novell.com)
//
// 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;
using System.Collections.Generic;
using Mono.Cecil;
using Gendarme.Framework.Rocks;
namespace Gendarme.Framework.Engines {
public class SuppressMessageEngine : Engine {
const string SuppressMessage = "System.Diagnostics.CodeAnalysis.SuppressMessageAttribute";
static Type fxCopCompatibility = typeof (FxCopCompatibilityAttribute);
private Dictionary<string, string> fxcopMapper;
public override void Initialize (EngineController controller)
{
base.Initialize (controller);
controller.BuildingAssembly += new EventHandler<EngineEventArgs> (OnAssembly);
fxcopMapper = new Dictionary<string,string> ();
foreach (IRule rule in Controller.Runner.Rules) {
Type type = rule.GetType ();
object [] attrs = type.GetCustomAttributes (fxCopCompatibility, true);
if (attrs.Length == 0)
continue;
// one Gendarme rule can be mapped to several FxCop rules
// one FxCop rules can be split across several Gendarme rules
foreach (FxCopCompatibilityAttribute attr in attrs) {
fxcopMapper.Add (attr.Category + "." + attr.CheckId, rule.FullName);
}
}
}
void OnAssembly (object sender, EngineEventArgs e)
{
// we only need to check the custom attributes if [SuppressMessage] is referenced (note: won't work for mscorlib)
AssemblyDefinition assembly = (sender as AssemblyDefinition);
if (assembly.MainModule.TypeReferences.Contains (SuppressMessage)) {
Controller.BuildingCustomAttributes += new EventHandler<EngineEventArgs> (OnCustomAttributes);
} else {
Controller.BuildingCustomAttributes -= new EventHandler<EngineEventArgs> (OnCustomAttributes);
}
}
void OnCustomAttributes (object sender, EngineEventArgs e)
{
ICustomAttributeProvider cap = (sender as ICustomAttributeProvider);
if (!cap.HasCustomAttributes)
return;
Dictionary<string, HashSet<string>> targets = null;
// deal with Target only for global (asembly-level) attributes
bool global = (sender is AssemblyDefinition);
foreach (CustomAttribute ca in cap.CustomAttributes) {
if (ca.Constructor.DeclaringType.FullName != SuppressMessage)
continue;
IList parameters = ca.ConstructorParameters;
string category = (string) parameters [0];
string checkId = (string) parameters [1];
if (String.IsNullOrEmpty (category) || String.IsNullOrEmpty (checkId))
continue;
IMetadataTokenProvider token = (sender as IMetadataTokenProvider);
string name = category + "." + checkId;
// map from FxCop - otherwise keep the Gendarme syntax
string mapped_name;
if (!fxcopMapper.TryGetValue (name, out mapped_name))
mapped_name = name;
// FIXME: Scope ? "member", "resource", "module", "type", "method", or "namespace"
string target = global ? (string) ca.Properties ["Target"] : null;
if (String.IsNullOrEmpty (target)) {
Controller.Runner.IgnoreList.Add (mapped_name, token);
// continue loop - [SuppressMessage] has AllowMultiple == true
continue;
}
// we do not want to look for each target individually since we do not know
// what they represent. Running the "big" loop one time is more than enough
HashSet<string> list = null;
if (targets == null)
targets = new Dictionary<string,HashSet<string>> ();
// inner types syntax fix
target = target.Replace ('+', '/');
// method/member syntax fix
target = target.Replace (".#", "::");
if (!targets.TryGetValue (target, out list)) {
list = new HashSet<string> ();
targets.Add (target, list);
}
list.AddIfNew (mapped_name);
}
if (targets != null)
Resolve (targets);
}
// scan the analysis code a single time looking for targets
private void Resolve (Dictionary<string,HashSet<string>> targets)
{
HashSet<string> rules;
// scan all code and look for targets
foreach (AssemblyDefinition assembly in Controller.Runner.Assemblies) {
// TODO ...
foreach (ModuleDefinition module in assembly.Modules) {
// TODO ...
foreach (TypeDefinition type in module.Types) {
if (targets.TryGetValue (type.FullName, out rules))
Add (type, rules);
if (type.HasConstructors) {
foreach (MethodDefinition ctor in type.Constructors)
ResolveMethod (ctor, targets);
}
if (type.HasMethods) {
foreach (MethodDefinition method in type.Methods)
ResolveMethod (method, targets);
}
}
}
}
}
private void ResolveMethod (IMetadataTokenProvider method, IDictionary<string, HashSet<string>> targets)
{
HashSet<string> rules;
string m = method.ToString ();
m = m.Substring (m.IndexOf (' ') + 1);
if (targets.TryGetValue (m, out rules))
Add (method, rules);
}
private void Add (IMetadataTokenProvider metadata, IEnumerable<string> rules)
{
foreach (string rule in rules) {
Controller.Runner.IgnoreList.Add (rule, metadata);
}
}
}
}
|
