The base architecture for code-contracts analysis
[mono.git] / mcs / class / Mono.CodeContracts / Mono.CodeContracts.Static.ControlFlow.Subroutines.Builders / SubroutineFactory.cs
1 // 
2 // SubroutineFactory.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.Visitors;
31 using Mono.CodeContracts.Static.Providers;
32
33 namespace Mono.CodeContracts.Static.ControlFlow.Subroutines.Builders {
34         abstract class SubroutineFactory<Key, Data> : ICodeConsumer<Data, Subroutine> {
35                 protected readonly SubroutineFacade SubroutineFacade;
36                 private readonly Dictionary<Key, Subroutine> cache = new Dictionary<Key, Subroutine> ();
37
38                 protected SubroutineFactory (SubroutineFacade subroutineFacade)
39                 {
40                         this.SubroutineFacade = subroutineFacade;
41                 }
42
43                 protected IContractProvider ContractProvider
44                 {
45                         get { return this.SubroutineFacade.ContractProvider; }
46                 }
47
48                 protected IMetaDataProvider MetaDataProvider
49                 {
50                         get { return this.SubroutineFacade.MetaDataProvider; }
51                 }
52
53                 #region ICodeConsumer<Data,Subroutine> Members
54                 public Subroutine Accept<Label> (ICodeProvider<Label> codeProvider, Label entryPoint, Data data)
55                 {
56                         return Factory (new SimpleSubroutineBuilder<Label> (codeProvider, this.SubroutineFacade, entryPoint), entryPoint, data);
57                 }
58                 #endregion
59
60                 public Subroutine Get (Key key)
61                 {
62                         if (this.cache.ContainsKey (key))
63                                 return this.cache [key];
64
65                         Subroutine sub = BuildNewSubroutine (key);
66                         this.cache.Add (key, sub);
67                         if (sub != null)
68                                 sub.Initialize ();
69                         return sub;
70                 }
71
72                 protected abstract Subroutine BuildNewSubroutine (Key key);
73                 protected abstract Subroutine Factory<Label> (SimpleSubroutineBuilder<Label> builder, Label entry, Data data);
74         }
75 }