The base architecture for code-contracts analysis
[mono.git] / mcs / class / Mono.CodeContracts / Mono.CodeContracts.Static.ContractExtraction / GatherLocals.cs
1 // 
2 // GatherLocals.cs
3 // 
4 // Authors:
5 //      Alexander Chebaturkin (chebaturkin@gmail.com)
6 // 
7 // Copyright (C) 2011 Alexander Chebaturkin
8 // 
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
16 // 
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
19 //  
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 // 
28
29 using System.Collections.Generic;
30 using Mono.CodeContracts.Static.AST;
31 using Mono.CodeContracts.Static.AST.Visitors;
32
33 namespace Mono.CodeContracts.Static.ContractExtraction {
34         class GatherLocals : NodeInspector {
35                 public HashSet<Local> Locals = new HashSet<Local> ();
36                 private Local exempt_result_local;
37
38                 public override void VisitLocal (Local node)
39                 {
40                         if (!IsLocalExempt (node) && !this.Locals.Contains (node))
41                                 this.Locals.Add (node);
42                         base.VisitLocal (node);
43                 }
44
45                 public override void VisitAssignmentStatement (AssignmentStatement node)
46                 {
47                         if (node.Target is Local && IsResultExpression (node.Source))
48                                 this.exempt_result_local = (Local) node.Target;
49                         base.VisitAssignmentStatement (node);
50                 }
51
52                 private bool IsResultExpression (Expression expression)
53                 {
54                         var methodCall = expression as MethodCall;
55                         if (methodCall == null)
56                                 return false;
57
58                         var memberBinding = methodCall.Callee as MemberBinding;
59                         if (memberBinding == null)
60                                 return false;
61
62                         var method = memberBinding.BoundMember as Method;
63                         if (method == null)
64                                 return false;
65
66                         return method.HasGenericParameters && method.Name == "Result" && method.DeclaringType != null && method.DeclaringType.Name == "Contract";
67                 }
68
69                 private bool IsLocalExempt (Local local)
70                 {
71                         if (local == this.exempt_result_local)
72                                 return true;
73                         bool result = false;
74                         if (local.Name != null && !local.Name.StartsWith ("local"))
75                                 result = true;
76                         TypeNode type = local.Type;
77                         if (type == null || HelperMethods.IsCompilerGenerated (type) || local.Name == "_preconditionHolds")
78                                 return true;
79
80                         if (result)
81                                 return LocalNameIsExempt (local.Name);
82
83                         return true;
84                 }
85
86                 private bool LocalNameIsExempt (string name)
87                 {
88                         return name.StartsWith ("CS$") || name.StartsWith ("VB$");
89                 }
90         }
91 }