The base architecture for code-contracts analysis
[mono.git] / mcs / class / Mono.CodeContracts / Mono.CodeContracts.Static.ControlFlow / ContractFilteredCFG.cs
1 // 
2 // ContractFilteredCFG.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;
30 using System.Collections.Generic;
31 using System.IO;
32 using Mono.CodeContracts.Static.Analysis;
33 using Mono.CodeContracts.Static.DataStructures;
34 using Mono.CodeContracts.Static.Providers;
35
36 namespace Mono.CodeContracts.Static.ControlFlow {
37         class ContractFilteredCFG : ICFG, IEdgeSubroutineAdaptor {
38                 private readonly ICFG underlying;
39
40                 public ContractFilteredCFG (ICFG cfg)
41                 {
42                         this.underlying = cfg;
43                 }
44
45                 #region ICFG Members
46                 public APC Entry
47                 {
48                         get { return this.underlying.Entry; }
49                 }
50
51                 public APC EntryAfterRequires
52                 {
53                         get { return this.underlying.EntryAfterRequires; }
54                 }
55
56                 public APC NormalExit
57                 {
58                         get { return this.underlying.NormalExit; }
59                 }
60
61                 public APC ExceptionExit
62                 {
63                         get { return this.underlying.ExceptionExit; }
64                 }
65
66                 public Subroutine Subroutine
67                 {
68                         get { return this.underlying.Subroutine; }
69                 }
70
71                 public APC Next (APC pc)
72                 {
73                         return this.underlying.Next (pc);
74                 }
75
76                 public bool HasSingleSuccessor (APC pc, out APC ifFound)
77                 {
78                         DecoratorHelper.Push<IEdgeSubroutineAdaptor> (this);
79                         try {
80                                 return this.underlying.HasSingleSuccessor (pc, out ifFound);
81                         } finally {
82                                 DecoratorHelper.Pop ();
83                         }
84                 }
85
86                 public IEnumerable<APC> Successors (APC pc)
87                 {
88                         DecoratorHelper.Push<IEdgeSubroutineAdaptor> (this);
89                         try {
90                                 return this.underlying.Successors (pc);
91                         } finally {
92                                 DecoratorHelper.Pop ();
93                         }
94                 }
95
96                 public bool HasSinglePredecessor (APC pc, out APC ifFound)
97                 {
98                         DecoratorHelper.Push<IEdgeSubroutineAdaptor> (this);
99                         try {
100                                 return this.underlying.HasSinglePredecessor (pc, out ifFound);
101                         } finally {
102                                 DecoratorHelper.Pop ();
103                         }
104                 }
105
106                 public IEnumerable<APC> Predecessors (APC pc)
107                 {
108                         DecoratorHelper.Push<IEdgeSubroutineAdaptor> (this);
109                         try {
110                                 return this.underlying.Predecessors (pc);
111                         } finally {
112                                 DecoratorHelper.Pop ();
113                         }
114                 }
115
116                 public bool IsJoinPoint (APC pc)
117                 {
118                         return this.underlying.IsJoinPoint (pc);
119                 }
120
121                 public bool IsSplitPoint (APC pc)
122                 {
123                         return this.underlying.IsSplitPoint (pc);
124                 }
125
126                 public bool IsBlockStart (APC pc)
127                 {
128                         return this.underlying.IsBlockStart (pc);
129                 }
130
131                 public bool IsBlockEnd (APC pc)
132                 {
133                         return this.underlying.IsBlockEnd (pc);
134                 }
135
136                 public IILDecoder<APC, Dummy, Dummy, IMethodContextProvider, Dummy> GetDecoder (IMetaDataProvider metaDataProvider)
137                 {
138                         return this.underlying.GetDecoder (metaDataProvider);
139                 }
140
141                 public void Print (TextWriter tw, ILPrinter<APC> printer,
142                                    Func<CFGBlock, IEnumerable<LispList<Edge<CFGBlock, EdgeTag>>>> contextLookup,
143                                    LispList<Edge<CFGBlock, EdgeTag>> context)
144                 {
145                         DecoratorHelper.Push<IEdgeSubroutineAdaptor> (this);
146                         try {
147                                 this.underlying.Print (tw, printer, contextLookup, context);
148                         } finally {
149                                 DecoratorHelper.Pop ();
150                         }
151                 }
152                 #endregion
153
154                 #region Implementation of IEdgeSubroutineAdaptor
155                 LispList<Pair<EdgeTag, Subroutine>> IEdgeSubroutineAdaptor.GetOrdinaryEdgeSubroutinesInternal (CFGBlock @from, CFGBlock to,
156                                                                                                                LispList<Edge<CFGBlock, EdgeTag>> context)
157                 {
158                         return DecoratorHelper.Inner<IEdgeSubroutineAdaptor> (this)
159                                 .GetOrdinaryEdgeSubroutinesInternal (from, to, context).Where ((pair) => !pair.Value.IsContract && !pair.Value.IsOldValue);
160                 }
161                 #endregion
162         }
163 }