mcs/class/Mono.CodeContracts/Mono.CodeContracts.Static.Analysis.ExpressionAnalysis.Expressions/Expr.cs

   1 //
   2 // Expr.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 Mono.CodeContracts.Static.AST.Visitors;
  32 using Mono.CodeContracts.Static.ControlFlow;
  33 using Mono.CodeContracts.Static.DataStructures;
  34
  35 namespace Mono.CodeContracts.Static.Analysis.ExpressionAnalysis.Expressions {
  36         abstract class Expr<TSymbolicValue> : IEquatable<Expr<TSymbolicValue>>
  37                 where TSymbolicValue : IEquatable<TSymbolicValue> {
  38
  39                 public abstract IEnumerable<TSymbolicValue> Variables { get; }
  40
  41                 public abstract bool Equals (Expr<TSymbolicValue> other);
  42
  43                 public abstract Result Decode<Data, Result, Visitor> (APC pc, TSymbolicValue dest, Visitor visitor, Data data)
  44                         where Visitor : IExpressionILVisitor<APC, TSymbolicValue, TSymbolicValue, Data, Result>;
  45
  46                 public abstract Expr<TSymbolicValue> Substitute (IImmutableMap<TSymbolicValue, Sequence<TSymbolicValue>> substitutions);
  47
  48                 /// <summary>
  49                 /// Specifies that current expression is partially contained in candidates
  50                 /// </summary>
  51                 public abstract bool IsContained (IImmutableSet<TSymbolicValue> candidates);
  52
  53                 public abstract bool Contains (TSymbolicValue symbol);
  54
  55                 public abstract override string ToString ();
  56         }
  57 }