mcs/class/Mono.CodeContracts/Mono.CodeContracts.Static.Analysis.HeapAnalysis/SymFunction.cs

   1 //
   2 // SymFunction.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 using System;
  29 using Mono.CodeContracts.Static.AST;
  30 using Mono.CodeContracts.Static.Analysis.HeapAnalysis.Paths;
  31 using Mono.CodeContracts.Static.Providers;
  32
  33 namespace Mono.CodeContracts.Static.Analysis.HeapAnalysis {
  34         abstract class SymFunction : IConstantInfo, IEquatable<SymFunction>, IVisibilityCheck<Method> {
  35                 protected readonly IMetaDataProvider MetaDataProvider;
  36
  37                 protected SymFunction (ref int idGen, IMetaDataProvider metaDataProvider)
  38                 {
  39                         this.MetaDataProvider = metaDataProvider;
  40                         idGen++;
  41                 }
  42
  43                 public abstract bool ActsAsField { get; }
  44                 public abstract bool IsVirtualMethod { get; }
  45                 public abstract bool IsStatic { get; }
  46
  47                 #region IConstantInfo Members
  48                 public abstract bool KeepAsBottomField { get; }
  49                 public abstract bool ManifestField { get; }
  50                 #endregion
  51
  52                 #region IVisibilityCheck<Method> Members
  53                 public abstract bool IfRootIsParameter { get; }
  54                 public abstract bool IsAsVisibleAs (Method member);
  55                 public abstract bool IsVisibleFrom (Method member);
  56                 #endregion
  57
  58                 public abstract TypeNode FieldAddressType ();
  59                 public abstract PathElementBase ToPathElement (bool tryCompact);
  60
  61                 public static Wrapper<T> For<T> (T value, ref int idGen, IMetaDataProvider metadataDecoder)
  62                 {
  63                         if (value is Parameter)
  64                                 return (Wrapper<T>) (object) new ParameterWrapper ((Parameter) (object) value, ref idGen, metadataDecoder);
  65                         if (value is Method)
  66                                 return (Wrapper<T>) (object) new MethodWrapper ((Method) (object) value, ref idGen, metadataDecoder);
  67
  68                         return new Wrapper<T> (value, ref idGen, metadataDecoder);
  69                 }
  70
  71                 #region Implementation of IEquatable<HeapAnalysis<Local,Parameter,Method,Field,Property,Event,Type,Attribute,Assembly>.Domain.SymFunction>
  72                 public bool Equals (SymFunction other)
  73                 {
  74                         return ReferenceEquals (this, other);
  75                 }
  76                 #endregion
  77         }
  78 }