forked from dotnet/roslyn-analyzers
/
ComputationalComplexityMetrics.cs
461 lines (414 loc) · 21.4 KB
/
ComputationalComplexityMetrics.cs
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
#if HAS_IOPERATION
using System;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Operations;
#if LEGACY_CODE_METRICS_MODE
using Analyzer.Utilities.Extensions;
#endif
namespace Microsoft.CodeAnalysis.CodeMetrics
{
/// <summary>
/// Calculates computational complexity metrics based on the number
/// of operators and operands found in the code.
/// </summary>
/// <remarks>This metric is based off of the Halstead metric.</remarks>
internal sealed class ComputationalComplexityMetrics
{
internal static readonly ComputationalComplexityMetrics Default = new ComputationalComplexityMetrics(0, 0, 0, 0, 0, ImmutableHashSet<OperationKind>.Empty,
ImmutableHashSet<BinaryOperatorKind>.Empty, ImmutableHashSet<UnaryOperatorKind>.Empty, ImmutableHashSet<CaseKind>.Empty, ImmutableHashSet<ISymbol>.Empty, ImmutableHashSet<object>.Empty);
private static readonly object s_nullConstantPlaceholder = new object();
private readonly long _operatorUsageCounts;
private readonly long _symbolUsageCounts;
private readonly long _constantUsageCounts;
private readonly ImmutableHashSet<OperationKind> _distinctOperatorKinds;
private readonly ImmutableHashSet<BinaryOperatorKind> _distinctBinaryOperatorKinds;
private readonly ImmutableHashSet<UnaryOperatorKind> _distinctUnaryOperatorKinds;
private readonly ImmutableHashSet<CaseKind> _distinctCaseKinds;
private readonly ImmutableHashSet<ISymbol> _distinctReferencedSymbols;
private readonly ImmutableHashSet<object> _distinctReferencedConstants;
private ComputationalComplexityMetrics(
long executableLinesOfCode,
long effectiveLinesOfMaintainableCode,
long operatorUsageCounts,
long symbolUsageCounts,
long constantUsageCounts,
ImmutableHashSet<OperationKind> distinctOperatorKinds,
ImmutableHashSet<BinaryOperatorKind> distinctBinaryOperatorKinds,
ImmutableHashSet<UnaryOperatorKind> distinctUnaryOperatorKinds,
ImmutableHashSet<CaseKind> distinctCaseKinds,
ImmutableHashSet<ISymbol> distinctReferencedSymbols,
ImmutableHashSet<object> distinctReferencedConstants)
{
ExecutableLines = executableLinesOfCode;
EffectiveLinesOfCode = effectiveLinesOfMaintainableCode;
_operatorUsageCounts = operatorUsageCounts;
_symbolUsageCounts = symbolUsageCounts;
_constantUsageCounts = constantUsageCounts;
_distinctOperatorKinds = distinctOperatorKinds;
_distinctBinaryOperatorKinds = distinctBinaryOperatorKinds;
_distinctUnaryOperatorKinds = distinctUnaryOperatorKinds;
_distinctCaseKinds = distinctCaseKinds;
_distinctReferencedSymbols = distinctReferencedSymbols;
_distinctReferencedConstants = distinctReferencedConstants;
}
private static ComputationalComplexityMetrics Create(
long executableLinesOfCode,
long operatorUsageCounts,
long symbolUsageCounts,
long constantUsageCounts,
bool hasSymbolInitializer,
ImmutableHashSet<OperationKind> distinctOperatorKinds,
ImmutableHashSet<BinaryOperatorKind> distinctBinaryOperatorKinds,
ImmutableHashSet<UnaryOperatorKind> distinctUnaryOperatorKinds,
ImmutableHashSet<CaseKind> distinctCaseKinds,
ImmutableHashSet<ISymbol> distinctReferencedSymbols,
ImmutableHashSet<object> distinctReferencedConstants)
{
if (executableLinesOfCode == 0 && operatorUsageCounts == 0 && symbolUsageCounts == 0 && constantUsageCounts == 0 && !hasSymbolInitializer)
{
return Default;
}
// Use incremented count for maintainable code lines for symbol initializers.
var effectiveLinesOfMaintainableCode = hasSymbolInitializer ? executableLinesOfCode + 1 : executableLinesOfCode;
return new ComputationalComplexityMetrics(executableLinesOfCode, effectiveLinesOfMaintainableCode, operatorUsageCounts, symbolUsageCounts, constantUsageCounts,
distinctOperatorKinds, distinctBinaryOperatorKinds, distinctUnaryOperatorKinds, distinctCaseKinds, distinctReferencedSymbols, distinctReferencedConstants);
}
public static ComputationalComplexityMetrics Compute(IOperation operationBlock)
{
bool hasSymbolInitializer = false;
long executableLinesOfCode = 0;
long operatorUsageCounts = 0;
long symbolUsageCounts = 0;
long constantUsageCounts = 0;
ImmutableHashSet<OperationKind>.Builder? distinctOperatorKindsBuilder = null;
ImmutableHashSet<BinaryOperatorKind>.Builder? distinctBinaryOperatorKindsBuilder = null;
ImmutableHashSet<UnaryOperatorKind>.Builder? distinctUnaryOperatorKindsBuilder = null;
ImmutableHashSet<CaseKind>.Builder? distinctCaseKindsBuilder = null;
ImmutableHashSet<ISymbol>.Builder? distinctReferencedSymbolsBuilder = null;
ImmutableHashSet<object>.Builder? distinctReferencedConstantsBuilder = null;
// Explicit user applied attribute.
if (operationBlock.Kind == OperationKind.None &&
hasAnyExplicitExpression(operationBlock))
{
executableLinesOfCode += 1;
}
foreach (var operation in operationBlock.Descendants())
{
executableLinesOfCode += getExecutableLinesOfCode(operation, ref hasSymbolInitializer);
if (operation.IsImplicit)
{
continue;
}
#if LEGACY_CODE_METRICS_MODE
// Legacy mode does not account for code within lambdas/local functions for code metrics.
if (operation.IsWithinLambdaOrLocalFunction())
{
continue;
}
#endif
if (operation.ConstantValue.HasValue)
{
constantUsageCounts++;
distinctReferencedConstantsBuilder ??= ImmutableHashSet.CreateBuilder<object>();
distinctReferencedConstantsBuilder.Add(operation.ConstantValue.Value ?? s_nullConstantPlaceholder);
continue;
}
switch (operation.Kind)
{
// Symbol references.
case OperationKind.LocalReference:
countOperand(((ILocalReferenceOperation)operation).Local);
continue;
case OperationKind.ParameterReference:
countOperand(((IParameterReferenceOperation)operation).Parameter);
continue;
case OperationKind.FieldReference:
case OperationKind.MethodReference:
case OperationKind.PropertyReference:
case OperationKind.EventReference:
countOperator(operation);
countOperand(((IMemberReferenceOperation)operation).Member);
continue;
// Symbol initializers.
case OperationKind.FieldInitializer:
foreach (var field in ((IFieldInitializerOperation)operation).InitializedFields)
{
countOperator(operation);
countOperand(field);
}
continue;
case OperationKind.PropertyInitializer:
foreach (var property in ((IPropertyInitializerOperation)operation).InitializedProperties)
{
countOperator(operation);
countOperand(property);
}
continue;
case OperationKind.ParameterInitializer:
countOperator(operation);
countOperand(((IParameterInitializerOperation)operation).Parameter);
continue;
case OperationKind.VariableInitializer:
countOperator(operation);
// We count the operand in the variable declarator.
continue;
case OperationKind.VariableDeclarator:
var variableDeclarator = (IVariableDeclaratorOperation)operation;
if (variableDeclarator.GetVariableInitializer() != null)
{
countOperand(variableDeclarator.Symbol);
}
continue;
// Invocations and Object creations.
case OperationKind.Invocation:
countOperator(operation);
var invocation = (IInvocationOperation)operation;
if (!invocation.TargetMethod.ReturnsVoid)
{
countOperand(invocation.TargetMethod);
}
continue;
case OperationKind.ObjectCreation:
countOperator(operation);
countOperand(((IObjectCreationOperation)operation).Constructor);
continue;
case OperationKind.DelegateCreation:
case OperationKind.AnonymousObjectCreation:
case OperationKind.TypeParameterObjectCreation:
case OperationKind.DynamicObjectCreation:
case OperationKind.DynamicInvocation:
countOperator(operation);
continue;
// Operators with special operator kinds.
case OperationKind.BinaryOperator:
countBinaryOperator(operation, ((IBinaryOperation)operation).OperatorKind);
continue;
case OperationKind.CompoundAssignment:
countBinaryOperator(operation, ((ICompoundAssignmentOperation)operation).OperatorKind);
continue;
case OperationKind.TupleBinaryOperator:
countBinaryOperator(operation, ((ITupleBinaryOperation)operation).OperatorKind);
continue;
case OperationKind.UnaryOperator:
countUnaryOperator(operation, ((IUnaryOperation)operation).OperatorKind);
continue;
case OperationKind.CaseClause:
var caseClauseOperation = (ICaseClauseOperation)operation;
distinctCaseKindsBuilder ??= ImmutableHashSet.CreateBuilder<CaseKind>();
distinctCaseKindsBuilder.Add(caseClauseOperation.CaseKind);
if (caseClauseOperation.CaseKind == CaseKind.Relational)
{
countBinaryOperator(operation, ((IRelationalCaseClauseOperation)operation).Relation);
}
else
{
countOperator(operation);
}
continue;
// Other common operators.
case OperationKind.Increment:
case OperationKind.Decrement:
case OperationKind.SimpleAssignment:
case OperationKind.DeconstructionAssignment:
case OperationKind.EventAssignment:
case OperationKind.Coalesce:
case OperationKind.ConditionalAccess:
case OperationKind.Conversion:
case OperationKind.ArrayElementReference:
case OperationKind.Await:
case OperationKind.NameOf:
case OperationKind.SizeOf:
case OperationKind.TypeOf:
case OperationKind.AddressOf:
case OperationKind.MemberInitializer:
case OperationKind.IsType:
case OperationKind.IsPattern:
case OperationKind.Parenthesized:
countOperator(operation);
continue;
// Following are considered operators for now, but we may want to revisit.
case OperationKind.ArrayCreation:
case OperationKind.ArrayInitializer:
case OperationKind.DynamicMemberReference:
case OperationKind.DynamicIndexerAccess:
case OperationKind.Tuple:
case OperationKind.Lock:
case OperationKind.Using:
case OperationKind.Throw:
case OperationKind.RaiseEvent:
case OperationKind.InterpolatedString:
countOperator(operation);
continue;
// Return value.
case OperationKind.Return:
case OperationKind.YieldBreak:
case OperationKind.YieldReturn:
if (((IReturnOperation)operation).ReturnedValue != null)
{
countOperator(operation);
}
continue;
}
}
return Create(
executableLinesOfCode,
operatorUsageCounts,
symbolUsageCounts,
constantUsageCounts,
hasSymbolInitializer,
distinctOperatorKindsBuilder != null ? distinctOperatorKindsBuilder.ToImmutable() : ImmutableHashSet<OperationKind>.Empty,
distinctBinaryOperatorKindsBuilder != null ? distinctBinaryOperatorKindsBuilder.ToImmutable() : ImmutableHashSet<BinaryOperatorKind>.Empty,
distinctUnaryOperatorKindsBuilder != null ? distinctUnaryOperatorKindsBuilder.ToImmutable() : ImmutableHashSet<UnaryOperatorKind>.Empty,
distinctCaseKindsBuilder != null ? distinctCaseKindsBuilder.ToImmutable() : ImmutableHashSet<CaseKind>.Empty,
distinctReferencedSymbolsBuilder != null ? distinctReferencedSymbolsBuilder.ToImmutable() : ImmutableHashSet<ISymbol>.Empty,
distinctReferencedConstantsBuilder != null ? distinctReferencedConstantsBuilder.ToImmutable() : ImmutableHashSet<object>.Empty);
static int getExecutableLinesOfCode(IOperation operation, ref bool hasSymbolInitializer)
{
if (operation.Parent != null)
{
switch (operation.Parent.Kind)
{
case OperationKind.Block:
return hasAnyExplicitExpression(operation) ? 1 : 0;
case OperationKind.FieldInitializer:
case OperationKind.PropertyInitializer:
case OperationKind.ParameterInitializer:
if (hasAnyExplicitExpression(operation))
{
hasSymbolInitializer = true;
return 1;
}
break;
case OperationKind.Conditional:
// Nested conditional
return operation.Kind == OperationKind.Conditional && hasAnyExplicitExpression(operation) ? 1 : 0;
}
}
return 0;
}
static bool hasAnyExplicitExpression(IOperation operation)
{
// Check if all descendants are either implicit or are explicit non-branch operations with no constant value or type, indicating it is not user written code.
return !operation.DescendantsAndSelf().All(o => o.IsImplicit || (!o.ConstantValue.HasValue && o.Type == null && o.Kind != OperationKind.Branch));
}
void countOperator(IOperation operation)
{
operatorUsageCounts++;
distinctOperatorKindsBuilder ??= ImmutableHashSet.CreateBuilder<OperationKind>();
distinctOperatorKindsBuilder.Add(operation.Kind);
}
void countOperand(ISymbol symbol)
{
symbolUsageCounts++;
distinctReferencedSymbolsBuilder ??= ImmutableHashSet.CreateBuilder<ISymbol>();
distinctReferencedSymbolsBuilder.Add(symbol);
}
void countBinaryOperator(IOperation operation, BinaryOperatorKind operatorKind)
{
countOperator(operation);
distinctBinaryOperatorKindsBuilder ??= ImmutableHashSet.CreateBuilder<BinaryOperatorKind>();
distinctBinaryOperatorKindsBuilder.Add(operatorKind);
}
void countUnaryOperator(IOperation operation, UnaryOperatorKind operatorKind)
{
countOperator(operation);
distinctUnaryOperatorKindsBuilder ??= ImmutableHashSet.CreateBuilder<UnaryOperatorKind>();
distinctUnaryOperatorKindsBuilder.Add(operatorKind);
}
}
public ComputationalComplexityMetrics Union(ComputationalComplexityMetrics other)
{
if (ReferenceEquals(this, Default))
{
return other;
}
else if (ReferenceEquals(other, Default))
{
return this;
}
return new ComputationalComplexityMetrics(
executableLinesOfCode: ExecutableLines + other.ExecutableLines,
effectiveLinesOfMaintainableCode: EffectiveLinesOfCode + other.EffectiveLinesOfCode,
operatorUsageCounts: _operatorUsageCounts + other._operatorUsageCounts,
symbolUsageCounts: _symbolUsageCounts + other._symbolUsageCounts,
constantUsageCounts: _constantUsageCounts + other._constantUsageCounts,
distinctOperatorKinds: _distinctOperatorKinds.Union(other._distinctOperatorKinds),
distinctBinaryOperatorKinds: _distinctBinaryOperatorKinds.Union(other._distinctBinaryOperatorKinds),
distinctUnaryOperatorKinds: _distinctUnaryOperatorKinds.Union(other._distinctUnaryOperatorKinds),
distinctCaseKinds: _distinctCaseKinds.Union(other._distinctCaseKinds),
distinctReferencedSymbols: _distinctReferencedSymbols.Union(other._distinctReferencedSymbols),
distinctReferencedConstants: _distinctReferencedConstants.Union(other._distinctReferencedConstants));
}
public bool IsDefault => ReferenceEquals(this, Default);
/// <summary>The number of unique operators found.</summary>
public long DistinctOperators //n1
{
get
{
var count = _distinctBinaryOperatorKinds.Count;
if (_distinctBinaryOperatorKinds.Count > 1)
{
count += _distinctBinaryOperatorKinds.Count - 1;
}
if (_distinctUnaryOperatorKinds.Count > 1)
{
count += _distinctUnaryOperatorKinds.Count - 1;
}
if (_distinctCaseKinds.Count > 1)
{
count += _distinctCaseKinds.Count - 1;
}
return count;
}
}
/// <summary>The number of unique operands found.</summary>
public long DistinctOperands //n2
{
get
{
return _distinctReferencedSymbols.Count + _distinctReferencedConstants.Count;
}
}
/// <summary>The total number of operator usages found.</summary>
public long TotalOperators //N1
{
get { return _operatorUsageCounts; }
}
/// <summary>The total number of operand usages found.</summary>
public long TotalOperands //N2
{
get
{
return _symbolUsageCounts + _constantUsageCounts;
}
}
public long Vocabulary //n
{
// n = n1 + n2
get { return DistinctOperators + DistinctOperands; }
}
public long Length //N
{
// N = N1 + N2
get { return TotalOperators + TotalOperands; }
}
public double Volume //V
{
// V = N * Log2(n)
get { return (Length * Math.Max(0.0, Math.Log(Vocabulary, 2))); }
}
/// <summary>
/// Count of executable lines of code, i.e. basically IOperations parented by IBlockOperation.
/// </summary>
public long ExecutableLines { get; }
/// <summary>
/// Count of effective lines of code for computation of maintainability index.
/// </summary>
public long EffectiveLinesOfCode { get; }
}
}
#endif