The base architecture for code-contracts analysis
[mono.git] / mcs / class / Mono.CodeContracts / Mono.CodeContracts.Static.ControlFlow / ICFG.cs
1 // 
2 // ICFG.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         interface ICFG {
38                 APC Entry { get; }
39                 APC EntryAfterRequires { get; }
40                 APC NormalExit { get; }
41                 APC ExceptionExit { get; }
42                 Subroutine Subroutine { get; }
43                 
44                 APC Next (APC pc);
45                 
46                 IEnumerable<APC> Successors (APC pc);
47                 bool HasSingleSuccessor (APC pc, out APC ifFound);
48
49                 IEnumerable<APC> Predecessors (APC pc);
50                 bool HasSinglePredecessor (APC pc, out APC ifFound);
51
52                 bool IsJoinPoint (APC pc);
53                 bool IsSplitPoint (APC pc);
54
55                 bool IsBlockStart (APC pc);
56                 bool IsBlockEnd (APC pc);
57
58                 IILDecoder<APC, Dummy, Dummy, IMethodContextProvider, Dummy> GetDecoder (IMetaDataProvider metaDataProvider);
59
60                 void Print (TextWriter tw, ILPrinter<APC> printer,
61                             Func<CFGBlock, IEnumerable<LispList<Edge<CFGBlock, EdgeTag>>>> contextLookup,
62                             LispList<Edge<CFGBlock, EdgeTag>> context);
63         }
64 }