//----------------------------------------------------------------------------- // // Copyright (C) Microsoft Corporation. All Rights Reserved. // //----------------------------------------------------------------------------- using System; using System.Text; using System.Collections.Generic; using System.Diagnostics.Contracts; using System.Numerics; using System.Linq; using Microsoft.Boogie; namespace Microsoft.Dafny { public class Program { [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(FullName != null); Contract.Invariant(DefaultModule != null); } public readonly string FullName; public List Modules; // filled in during resolution. // Resolution essentially flattens the module hierarchy, for // purposes of translation and compilation. public List CompileModules; // filled in during resolution. // Contains the definitions to be used for compilation. List _additionalInformation = new List(); public List AdditionalInformation { get { return _additionalInformation; } } public readonly ModuleDecl DefaultModule; public readonly ModuleDefinition DefaultModuleDef; public readonly BuiltIns BuiltIns; public readonly List TranslationTasks; public Program(string name, [Captured] ModuleDecl module, [Captured] BuiltIns builtIns) { Contract.Requires(name != null); Contract.Requires(module != null); Contract.Requires(module is LiteralModuleDecl); FullName = name; DefaultModule = module; DefaultModuleDef = (DefaultModuleDecl)((LiteralModuleDecl)module).ModuleDef; BuiltIns = builtIns; Modules = new List(); CompileModules = new List(); TranslationTasks = new List(); } public string Name { get { try { return System.IO.Path.GetFileName(FullName); } catch (ArgumentException) { return FullName; } } } } public class Include : IComparable { public readonly IToken tok; public readonly string filename; public readonly string fullPath; public Include(IToken tok, string theFilename, string fullPath) { this.tok = tok; this.filename = theFilename; this.fullPath = fullPath; } public int CompareTo(object obj) { var i = obj as Include; if (i != null) { return this.fullPath.CompareTo(i.fullPath); } else { throw new NotImplementedException(); } } } public class BuiltIns { public readonly ModuleDefinition SystemModule = new ModuleDefinition(Token.NoToken, "_System", false, false, null, null, null, true); Dictionary arrayTypeDecls = new Dictionary(); Dictionary tupleTypeDecls = new Dictionary(); public readonly ClassDecl ObjectDecl; public readonly ClassDecl RealClass; //public readonly Function RealToInt; //public readonly Function IntToReal; public BuiltIns() { // create class 'object' ObjectDecl = new ClassDecl(Token.NoToken, "object", SystemModule, new List(), new List(), DontCompile()); SystemModule.TopLevelDecls.Add(ObjectDecl); // add one-dimensional arrays, since they may arise during type checking // Arrays of other dimensions may be added during parsing as the parser detects the need for these UserDefinedType tmp = ArrayType(1, Type.Int, true); // add real number functions Function RealToInt = new Function(Token.NoToken, "RealToInt", true, true, new List(), Token.NoToken, new List { new Formal(Token.NoToken, "x", Type.Real, true, true) }, Type.Int, new List(), new List(), new List(), new Specification(new List(), null), null, null, Token.NoToken); Function IntToReal = new Function(Token.NoToken, "IntToReal", true, true, new List(), Token.NoToken, new List { new Formal(Token.NoToken, "x", Type.Int, true, true) }, Type.Real, new List(), new List(), new List(), new Specification(new List(), null), null, null, Token.NoToken); RealClass = new ClassDecl(Token.NoToken, "Real", SystemModule, new List(), new List() { RealToInt, IntToReal }, DontCompile()); RealToInt.EnclosingClass = RealClass; IntToReal.EnclosingClass = RealClass; RealToInt.IsBuiltin = true; IntToReal.IsBuiltin = true; SystemModule.TopLevelDecls.Add(RealClass); // Note, in addition to these types, the _System module contains tuple types. These tuple types are added to SystemModule // by the parser as the parser detects the need for these. } private Attributes DontCompile() { var flse = new Attributes.Argument(Token.NoToken, Expression.CreateBoolLiteral(Token.NoToken, false)); return new Attributes("compile", new List() { flse }, null); } public UserDefinedType ArrayType(int dims, Type arg, bool allowCreationOfNewClass = false) { Contract.Requires(1 <= dims); Contract.Requires(arg != null); return ArrayType(Token.NoToken, dims, new List() { arg }, allowCreationOfNewClass); } public UserDefinedType ArrayType(IToken tok, int dims, List typeArgs, bool allowCreationOfNewClass) { Contract.Requires(tok != null); Contract.Requires(1 <= dims); Contract.Requires(typeArgs != null); Contract.Ensures(Contract.Result() != null); UserDefinedType udt = new UserDefinedType(tok, ArrayClassName(dims), typeArgs, null); if (allowCreationOfNewClass && !arrayTypeDecls.ContainsKey(dims)) { ArrayClassDecl arrayClass = new ArrayClassDecl(dims, SystemModule, DontCompile()); for (int d = 0; d < dims; d++) { string name = dims == 1 ? "Length" : "Length" + d; string compiledName = dims == 1 ? "Length" : "GetLength(" + d + ")"; Field len = new SpecialField(Token.NoToken, name, compiledName, "new BigInteger(", ")", false, false, false, Type.Int, null); len.EnclosingClass = arrayClass; // resolve here arrayClass.Members.Add(len); } arrayTypeDecls.Add(dims, arrayClass); SystemModule.TopLevelDecls.Add(arrayClass); } udt.ResolvedClass = arrayTypeDecls[dims]; return udt; } public static string ArrayClassName(int dims) { Contract.Requires(1 <= dims); if (dims == 1) { return "array"; } else { return "array" + dims; } } public TupleTypeDecl TupleType(IToken tok, int dims, bool allowCreationOfNewType) { Contract.Requires(tok != null); Contract.Requires(0 <= dims); Contract.Ensures(Contract.Result() != null); TupleTypeDecl tt; if (!tupleTypeDecls.TryGetValue(dims, out tt)) { Contract.Assume(allowCreationOfNewType); // the parser should ensure that all needed tuple types exist by the time of resolution tt = new TupleTypeDecl(dims, SystemModule); tupleTypeDecls.Add(dims, tt); SystemModule.TopLevelDecls.Add(tt); } return tt; } public static string TupleTypeName(int dims) { Contract.Requires(0 <= dims); return "_tuple#" + dims; } public static bool IsTupleTypeName(string s) { Contract.Requires(s != null); return s.StartsWith("_tuple#"); } public const string TupleTypeCtorName = "_#Make"; // the printer wants this name to be uniquely recognizable } public class Attributes { [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(Name != null); Contract.Invariant(cce.NonNullElements(Args)); } public readonly string Name; /*Frozen*/ public readonly List Args; public readonly Attributes Prev; public Attributes(string name, [Captured] List args, Attributes prev) { Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(args)); Name = name; Args = args; Prev = prev; } public static IEnumerable SubExpressions(Attributes attrs) { for (; attrs != null; attrs = attrs.Prev) { foreach (var arg in attrs.Args) { if (arg.E != null) { yield return arg.E; } } } } public static bool Contains(Attributes attrs, string nm) { Contract.Requires(nm != null); for (; attrs != null; attrs = attrs.Prev) { if (attrs.Name == nm) { return true; } } return false; } /// /// Returns true if "nm" is a specified attribute. If it is, then: /// - if the attribute is {:nm true}, then value==true /// - if the attribute is {:nm false}, then value==false /// - if the attribute is anything else, then value returns as whatever it was passed in as. /// public static bool ContainsBool(Attributes attrs, string nm, ref bool value) { Contract.Requires(nm != null); for (; attrs != null; attrs = attrs.Prev) { if (attrs.Name == nm) { if (attrs.Args.Count == 1) { var arg = attrs.Args[0].E as LiteralExpr; if (arg != null && arg.Value is bool) { value = (bool)arg.Value; } } return true; } } return false; } /// /// Checks whether a Boolean attribute has been set on the declaration itself, /// the enclosing class, or any enclosing module. Settings closer to the declaration /// override those further away. /// public static bool ContainsBoolAtAnyLevel(MemberDecl decl, string attribName) { bool setting = true; if (Attributes.ContainsBool(decl.Attributes, attribName, ref setting)) { return setting; } if (Attributes.ContainsBool(decl.EnclosingClass.Attributes, attribName, ref setting)) { return setting; } // Check the entire stack of modules var mod = decl.EnclosingClass.Module; while (mod != null) { if (Attributes.ContainsBool(mod.Attributes, attribName, ref setting)) { return setting; } mod = mod.Module; } return false; } public class Argument { public readonly IToken Tok; public readonly string S; public readonly Expression E; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(Tok != null); Contract.Invariant((S == null) != (E == null)); } public Argument(IToken tok, string s) { Contract.Requires(tok != null); Contract.Requires(s != null); Tok = tok; S = s; } public Argument(IToken tok, Expression e) { Contract.Requires(tok != null); Contract.Requires(e != null); Tok = tok; E = e; } } } // ------------------------------------------------------------------------------------------------------ public abstract class Type { public static readonly BoolType Bool = new BoolType(); public static readonly IntType Int = new IntType(); public static readonly RealType Real = new RealType(); /// /// Used in error situations in order to reduce further error messages. /// //[Pure(false)] public static Type Flexible { get { Contract.Ensures(Contract.Result() != null); return new InferredTypeProxy(); } } [Pure] public abstract string TypeName(ModuleDefinition/*?*/ context); [Pure] public override string ToString() { return TypeName(null); } /// /// Return the most constrained version of "this". /// /// public Type Normalize() { Contract.Ensures(Contract.Result() != null); Type type = this; while (true) { TypeProxy pt = type as TypeProxy; if (pt != null && pt.T != null) { type = pt.T; } else { return type; } } } [Pure] public abstract bool Equals(Type that); public bool IsSubrangeType { get { return this is NatType; } } public bool IsRefType { get { if (this is ObjectType) { return true; } else { UserDefinedType udt = this as UserDefinedType; return udt != null && udt.ResolvedParam == null && udt.ResolvedClass is ClassDecl; } } } public bool IsArrayType { get { return AsArrayType != null; } } public ArrayClassDecl/*?*/ AsArrayType { get { UserDefinedType udt = UserDefinedType.DenotesClass(this); return udt == null ? null : udt.ResolvedClass as ArrayClassDecl; } } public bool IsDatatype { get { return AsDatatype != null; } } public DatatypeDecl AsDatatype { get { UserDefinedType udt = this as UserDefinedType; if (udt == null) { return null; } else { return udt.ResolvedClass as DatatypeDecl; } } } public bool IsIndDatatype { get { return AsIndDatatype != null; } } public IndDatatypeDecl AsIndDatatype { get { UserDefinedType udt = this as UserDefinedType; if (udt == null) { return null; } else { return udt.ResolvedClass as IndDatatypeDecl; } } } public bool IsCoDatatype { get { return AsCoDatatype != null; } } public CoDatatypeDecl AsCoDatatype { get { UserDefinedType udt = this as UserDefinedType; if (udt == null) { return null; } else { return udt.ResolvedClass as CoDatatypeDecl; } } } public bool InvolvesCoDatatype { get { return IsCoDatatype; // TODO: should really check structure of the type recursively } } public bool IsTypeParameter { get { return AsTypeParameter != null; } } public TypeParameter AsTypeParameter { get { UserDefinedType ct = this as UserDefinedType; return ct == null ? null : ct.ResolvedParam; } } public virtual bool SupportsEquality { get { return true; } } /// /// Returns true if it is known how to meaningfully compare the type's inhabitants. /// public bool IsOrdered { get { return !IsTypeParameter && !IsCoDatatype; } } } /// /// A NonProxy type is a fully constrained type. It may contain members. /// public abstract class NonProxyType : Type { } public abstract class BasicType : NonProxyType { } public class BoolType : BasicType { [Pure] public override string TypeName(ModuleDefinition context) { return "bool"; } public override bool Equals(Type that) { return that.Normalize() is BoolType; } } public class IntType : BasicType { [Pure] public override string TypeName(ModuleDefinition context) { return "int"; } public override bool Equals(Type that) { return that.Normalize() is IntType; } } public class NatType : IntType { [Pure] public override string TypeName(ModuleDefinition context) { return "nat"; } } public class RealType : BasicType { [Pure] public override string TypeName(ModuleDefinition context) { return "real"; } public override bool Equals(Type that) { return that.Normalize() is RealType; } } public class ObjectType : BasicType { [Pure] public override string TypeName(ModuleDefinition context) { return "object"; } public override bool Equals(Type that) { return that.Normalize() is ObjectType; } } public abstract class CollectionType : NonProxyType { public abstract string CollectionTypeName { get; } public override string TypeName(ModuleDefinition context) { Contract.Ensures(Contract.Result() != null); var targs = HasTypeArg() ? "<" + Arg.TypeName(context) + ">" : ""; return CollectionTypeName + targs; } public Type Arg { get { Contract.Ensures(Contract.Result() != null); // this is true only after "arg" has really been set (i.e., it follows from the precondition) Contract.Assume(arg != null); // This is really a precondition. Don't call Arg until "arg" has been set. return arg; } } // denotes the Domain type for a Map private Type arg; // The following two methods, HasTypeArg and SetTypeArg, are to be called during resolution to make sure that "arg" becomes set. public bool HasTypeArg() { return arg != null; } public void SetTypeArg(Type arg) { Contract.Requires(arg != null); Contract.Assume(this.arg == null); // Can only set it once. This is really a precondition. this.arg = arg; } [ContractInvariantMethod] void ObjectInvariant() { // After resolution, the following is invariant: Contract.Invariant(Arg != null); // However, it may not be true until then. } public CollectionType(Type arg) { this.arg = arg; } public override bool SupportsEquality { get { return Arg.SupportsEquality; } } } public class SetType : CollectionType { public SetType(Type arg) : base(arg) { } public override string CollectionTypeName { get { return "set"; } } [Pure] public override bool Equals(Type that) { var t = that.Normalize() as SetType; return t != null && Arg.Equals(t.Arg); } } public class MultiSetType : CollectionType { public MultiSetType(Type arg) : base(arg) { } public override string CollectionTypeName { get { return "multiset"; } } public override bool Equals(Type that) { var t = that.Normalize() as MultiSetType; return t != null && Arg.Equals(t.Arg); } } public class SeqType : CollectionType { public SeqType(Type arg) : base(arg) { } public override string CollectionTypeName { get { return "seq"; } } public override bool Equals(Type that) { var t = that.Normalize() as SeqType; return t != null && Arg.Equals(t.Arg); } } public class MapType : CollectionType { public Type Range { get { return range; } } private Type range; public void SetRangetype(Type range) { Contract.Requires(range != null); Contract.Assume(this.range == null); // Can only set once. This is really a precondition. this.range = range; } public MapType(Type domain, Type range) : base(domain) { Contract.Requires((domain == null && range == null) || (domain != null && range != null)); this.range = range; } public Type Domain { get { return Arg; } } public override string CollectionTypeName { get { return "map"; } } [Pure] public override string TypeName(ModuleDefinition context) { Contract.Ensures(Contract.Result() != null); var targs = HasTypeArg() ? "<" + Domain.TypeName(context) + ", " + Range.TypeName(context) + ">" : ""; return CollectionTypeName + targs; } public override bool Equals(Type that) { var t = that.Normalize() as MapType; return t != null && Arg.Equals(t.Arg) && Range.Equals(t.Range); } } public class UserDefinedType : NonProxyType { [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(tok != null); Contract.Invariant(Name != null); Contract.Invariant(cce.NonNullElements(TypeArgs)); Contract.Invariant(cce.NonNullElements(Path)); } public readonly List Path; public readonly IToken tok; // token of the Name public readonly string Name; [Rep] public readonly List TypeArgs; public string FullName { get { if (ResolvedClass != null && !ResolvedClass.Module.IsDefaultModule) { return ResolvedClass.Module.Name + "." + Name; } else { return Name; } } } string compileName; public string CompileName { get { if (compileName == null) { compileName = NonglobalVariable.CompilerizeName(Name); } return compileName; } } public string FullCompileName { get { if (ResolvedClass != null && !ResolvedClass.Module.IsDefaultModule) { return ResolvedClass.Module.CompileName + ".@" + CompileName; } else { return CompileName; } } } public TopLevelDecl ResolvedClass; // filled in by resolution, if Name denotes a class/datatype/iterator and TypeArgs match the type parameters of that class/datatype/iterator public TypeParameter ResolvedParam; // filled in by resolution, if Name denotes an enclosing type parameter and TypeArgs is the empty list public UserDefinedType(IToken tok, string name, [Captured] List typeArgs, List moduleName) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(moduleName == null || cce.NonNullElements(moduleName)); if (moduleName != null) this.Path = moduleName; else this.Path = new List(); this.tok = tok; this.Name = name; this.TypeArgs = typeArgs; } /// /// This constructor constructs a resolved class/datatype/iterator type /// public UserDefinedType(IToken tok, string name, TopLevelDecl cd, [Captured] List typeArgs) : this(tok, name, cd, typeArgs, null) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cd != null); Contract.Requires(cce.NonNullElements(typeArgs)); } /// /// This constructor constructs a resolved class/datatype/iterator type /// public UserDefinedType(IToken tok, string name, TopLevelDecl cd, [Captured] List typeArgs, List moduleName) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cd != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(moduleName == null || cce.NonNullElements(moduleName)); this.tok = tok; this.Name = name; this.ResolvedClass = cd; this.TypeArgs = typeArgs; if (moduleName != null) this.Path = moduleName; else this.Path = new List(); } /// /// This constructor constructs a resolved type parameter /// public UserDefinedType(IToken tok, string name, TypeParameter tp) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(tp != null); this.tok = tok; this.Name = name; this.TypeArgs = new List(); this.ResolvedParam = tp; this.Path = new List(); } public override bool Equals(Type that) { var t = that.Normalize() as UserDefinedType; return t != null && ResolvedClass == t.ResolvedClass && ResolvedParam == t.ResolvedParam; } /// /// If type denotes a resolved class type, then return that class type. /// Otherwise, return null. /// public static UserDefinedType DenotesClass(Type type) { Contract.Requires(type != null); Contract.Ensures(Contract.Result() == null || Contract.Result().ResolvedClass is ClassDecl); type = type.Normalize(); UserDefinedType ct = type as UserDefinedType; if (ct != null && ct.ResolvedClass is ClassDecl) { return ct; } else { return null; } } public static Type ArrayElementType(Type type) { Contract.Requires(type.IsArrayType); Contract.Requires(type != null); Contract.Ensures(Contract.Result() != null); UserDefinedType udt = DenotesClass(type); Contract.Assert(udt != null); Contract.Assert(udt.TypeArgs.Count == 1); // holds true of all array types return udt.TypeArgs[0]; } [Pure] public override string TypeName(ModuleDefinition context) { Contract.Ensures(Contract.Result() != null); if (BuiltIns.IsTupleTypeName(Name)) { return "(" + Util.Comma(",", TypeArgs, ty => ty.TypeName(context)) + ")"; } string s = ""; foreach (var t in Path) { if (context != null && t == context.tok) { // drop the prefix up to here s = ""; } else { s += t.val + "."; } } s += Name; if (TypeArgs.Count != 0) { s += "<" + Util.Comma(",", TypeArgs, ty => ty.TypeName(context)) + ">"; } return s; } public override bool SupportsEquality { get { if (ResolvedClass is ClassDecl) { return true; } else if (ResolvedClass is CoDatatypeDecl) { return false; } else if (ResolvedClass is IndDatatypeDecl) { var dt = (IndDatatypeDecl)ResolvedClass; Contract.Assume(dt.EqualitySupport != IndDatatypeDecl.ES.NotYetComputed); if (dt.EqualitySupport == IndDatatypeDecl.ES.Never) { return false; } Contract.Assert(dt.TypeArgs.Count == TypeArgs.Count); var i = 0; foreach (var tp in dt.TypeArgs) { if (tp.NecessaryForEqualitySupportOfSurroundingInductiveDatatype && !TypeArgs[i].SupportsEquality) { return false; } i++; } return true; } else if (ResolvedParam != null) { return ResolvedParam.MustSupportEquality; } Contract.Assume(false); // the SupportsEquality getter requires the Type to have been successfully resolved return true; } } } public abstract class TypeProxy : Type { public Type T; // filled in during resolution internal TypeProxy() { } [Pure] public override string TypeName(ModuleDefinition context) { Contract.Ensures(Contract.Result() != null); return T == null ? "?" : T.TypeName(context); } public override bool SupportsEquality { get { if (T != null) { return T.SupportsEquality; } else { return base.SupportsEquality; } } } public override bool Equals(Type that) { var i = Normalize(); if (i is TypeProxy) { var u = that.Normalize() as TypeProxy; return u != null && object.ReferenceEquals(i, u); } else { return i.Equals(that); } } } public abstract class UnrestrictedTypeProxy : TypeProxy { } /// /// This proxy stands for any type. /// public class InferredTypeProxy : UnrestrictedTypeProxy { } /// /// This proxy stands for any type, but it originates from an instantiated type parameter. /// public class ParamTypeProxy : UnrestrictedTypeProxy { public TypeParameter orig; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(orig != null); } public ParamTypeProxy(TypeParameter orig) { Contract.Requires(orig != null); this.orig = orig; } } public abstract class RestrictedTypeProxy : TypeProxy { /// /// The OrderID is used to simplify the unification code. Each restricted type proxy should use its /// own OrderID. /// public abstract int OrderID { get; } } /// /// This proxy stands for any datatype. /// public class DatatypeProxy : RestrictedTypeProxy { public readonly bool Co; // false means only inductive datatypes; true means only co-inductive datatypes public DatatypeProxy(bool co) { Co = co; } public override int OrderID { get { return 0; } } } /// /// This proxy stands for object or any class/array type. /// public class ObjectTypeProxy : RestrictedTypeProxy { public override int OrderID { get { return 1; } } } /// /// This proxy stands for: /// set(Arg) or multiset(Arg) or seq(Arg) or map(Arg, anyRange) /// public class CollectionTypeProxy : RestrictedTypeProxy { public readonly Type Arg; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(Arg != null); } public CollectionTypeProxy(Type arg) { Contract.Requires(arg != null); Arg = arg; } public override int OrderID { get { return 2; } } } /// /// This proxy stands for either: /// int or real or set or multiset or seq /// if AllowSeq, or: /// int or real or set or multiset /// if !AllowSeq. /// public class OperationTypeProxy : RestrictedTypeProxy { public readonly bool AllowSeq; public OperationTypeProxy(bool allowSeq) { AllowSeq = allowSeq; } public override int OrderID { get { return 3; } } } /// /// Domain and Range refer to the types of the indexing operation. That is, in A[i], /// i is of type Domain and A[i] is of type Range. /// Arg is either Domain or Range, depending on what type it is. Arg is the type /// one would use in an expression "x in C", whereas /// This proxy stands for one of: /// seq(T) Domain,Range,Arg := int,T,T /// multiset(T) Domain,Range,Arg := T,int,T /// map(T,U) Domain,Range,Arg := T,U,T /// if AllowArray, may also be: /// array(T) Domain,Range,Arg := int,T,T /// public class IndexableTypeProxy : RestrictedTypeProxy { public readonly bool AllowArray; public readonly Type Domain, Range, Arg; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(Domain != null); Contract.Invariant(Range != null); Contract.Invariant(Arg != null); } public IndexableTypeProxy(Type domain, Type range, Type arg, bool allowArray) { Contract.Requires(domain != null); Contract.Requires(range != null); Contract.Requires(arg != null); Domain = domain; Range = range; Arg = arg; AllowArray = allowArray; } public override int OrderID { get { return 4; } } } // ------------------------------------------------------------------------------------------------------ public abstract class Declaration : IUniqueNameGenerator { [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(tok != null); Contract.Invariant(Name != null); } public IToken tok; public IToken BodyStartTok = Token.NoToken; public IToken BodyEndTok = Token.NoToken; public readonly string Name; string compileName; public virtual string CompileName { get { if (compileName == null) { compileName = NonglobalVariable.CompilerizeName(Name); } return compileName; } } public Attributes Attributes; // readonly, except during class merging in the refinement transformations public Declaration(IToken tok, string name, Attributes attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); this.tok = tok; this.Name = name; this.Attributes = attributes; } [Pure] public override string ToString() { Contract.Ensures(Contract.Result() != null); return Name; } int nameCount; public int GenerateId(string name) { return nameCount++; } } public class TypeParameter : Declaration { public interface ParentType { } [Peer] ParentType parent; public ParentType Parent { get { return parent; } [param: Captured] set { Contract.Requires(Parent == null); // set it only once Contract.Requires(value != null); // BUGBUG: The following line is a workaround to tell the verifier that 'value' is not of an Immutable type. // A proper solution would be to be able to express that in the program (in a specification or attribute) or // to be able to declare 'parent' as [PeerOrImmutable]. Contract.Requires(value is TopLevelDecl || value is Function || value is Method || value is DatatypeCtor); //modifies parent; parent = value; } } public enum EqualitySupportValue { Required, InferredRequired, Unspecified } public EqualitySupportValue EqualitySupport; // the resolver may change this value from Unspecified to InferredRequired (for some signatures that may immediately imply that equality support is required) public bool MustSupportEquality { get { return EqualitySupport != EqualitySupportValue.Unspecified; } } public bool NecessaryForEqualitySupportOfSurroundingInductiveDatatype = false; // computed during resolution; relevant only when Parent denotes an IndDatatypeDecl public bool IsAbstractTypeDeclaration { // true if this type parameter represents t in type t; get { return parent == null; } } public bool IsToplevelScope { // true if this type parameter is on a toplevel (ie. class C), and false if it is on a member (ie. method m(...)) get { return parent is TopLevelDecl; } } public int PositionalIndex; // which type parameter this is (ie. in C, S is 0, T is 1 and U is 2). public TypeParameter(IToken tok, string name, EqualitySupportValue equalitySupport = EqualitySupportValue.Unspecified) : base(tok, name, null) { Contract.Requires(tok != null); Contract.Requires(name != null); EqualitySupport = equalitySupport; } } // Represents a submodule declaration at module level scope abstract public class ModuleDecl : TopLevelDecl { public ModuleSignature Signature; // filled in by resolution, in topological order. public int Height; public readonly bool Opened; public ModuleDecl(IToken tok, string name, ModuleDefinition parent, bool opened) : base(tok, name, parent, new List(), null) { Height = -1; Signature = null; Opened = opened; } } // Represents module X { ... } public class LiteralModuleDecl : ModuleDecl { public readonly ModuleDefinition ModuleDef; public LiteralModuleDecl(ModuleDefinition module, ModuleDefinition parent) : base(module.tok, module.Name, parent, false) { ModuleDef = module; } } // Represents "module name = path;", where name is a identifier and path is a possibly qualified name. public class AliasModuleDecl : ModuleDecl { public ModuleDecl ModuleReference; // should refer to another declaration somewhere. NOTE: cyclicity is possible, and should // be detected and warned. public readonly List Path; // generated by the parser, this is looked up public ModuleDecl Root; // the moduleDecl that Path[0] refers to. public AliasModuleDecl(List path, IToken name, ModuleDefinition parent, bool opened) : base(name, name.val, parent, opened) { Contract.Requires(path != null && path.Count > 0); Path = path; ModuleReference = null; } } // Represents "module name as path [ = compilePath];", where name is a identifier and path is a possibly qualified name. public class ModuleFacadeDecl : ModuleDecl { public ModuleDecl Root; public readonly List Path; public ModuleDecl CompileRoot; public readonly List CompilePath; public ModuleSignature OriginalSignature; public ModuleFacadeDecl(List path, IToken name, ModuleDefinition parent, List compilePath, bool opened) : base(name, name.val, parent, opened) { Path = path; Root = null; CompilePath = compilePath; } } public class ModuleSignature { public readonly Dictionary TopLevels = new Dictionary(); public readonly Dictionary> Ctors = new Dictionary>(); public readonly Dictionary StaticMembers = new Dictionary(); public ModuleDefinition ModuleDef = null; // Note: this is null if this signature does not correspond to a specific definition (i.e. // it is abstract). Otherwise, it points to that definition. public ModuleSignature CompileSignature = null; // This is the version of the signature that should be used at compile time. public ModuleSignature Refines = null; public bool IsGhost = false; public ModuleSignature() {} public bool FindSubmodule(string name, out ModuleSignature pp) { TopLevelDecl top; pp = null; if (TopLevels.TryGetValue(name, out top)) { if (top is ModuleDecl) { pp = ((ModuleDecl)top).Signature; return true; } else return false; } else return false; } } public class ModuleDefinition : TopLevelDecl { public readonly List RefinementBaseName; // null if no refinement base public ModuleDecl RefinementBaseRoot; // filled in early during resolution, corresponds to RefinementBaseName[0] public ModuleDefinition RefinementBase; // filled in during resolution (null if no refinement base) public List Includes; public readonly List TopLevelDecls = new List(); // filled in by the parser; readonly after that public readonly Graph CallGraph = new Graph(); // filled in during resolution public int Height; // height in the topological sorting of modules; filled in during resolution public readonly bool IsAbstract; public readonly bool IsFacade; // True iff this module represents a module facade (that is, an abstract interface) private readonly bool IsBuiltinName; // true if this is something like _System that shouldn't have it's name mangled. [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(TopLevelDecls)); Contract.Invariant(CallGraph != null); } public ModuleDefinition(IToken tok, string name, bool isAbstract, bool isFacade, List refinementBase, ModuleDefinition parent, Attributes attributes, bool isBuiltinName) : base(tok, name, parent, new List(), attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); RefinementBaseName = refinementBase; IsAbstract = isAbstract; IsFacade = isFacade; RefinementBaseRoot = null; RefinementBase = null; Includes = new List(); IsBuiltinName = isBuiltinName; } public virtual bool IsDefaultModule { get { return false; } } string compileName; new public string CompileName { get { if (compileName == null) { if (IsBuiltinName) compileName = Name; else compileName = "_" + Height.ToString() + "_" + NonglobalVariable.CompilerizeName(Name); } return compileName; } } /// /// Determines if "a" and "b" are in the same strongly connected component of the call graph, that is, /// if "a" and "b" are mutually recursive. /// Assumes that CallGraph has already been filled in for the modules containing "a" and "b". /// public static bool InSameSCC(ICallable a, ICallable b) { Contract.Requires(a != null); Contract.Requires(b != null); var module = a.EnclosingModule; return module == b.EnclosingModule && module.CallGraph.GetSCCRepresentative(a) == module.CallGraph.GetSCCRepresentative(b); } /// /// Return the representative elements of the SCCs that contain contain any member declaration in a /// class in "declarations". /// Note, the representative element may in some cases be a Method, not necessarily a Function. /// public static IEnumerable AllFunctionSCCs(List declarations) { var set = new HashSet(); foreach (var d in declarations) { var cl = d as ClassDecl; if (cl != null) { var module = cl.Module; foreach (var member in cl.Members) { var fn = member as Function; if (fn != null) { var repr = module.CallGraph.GetSCCRepresentative(fn); set.Add(repr); } } } } return set; } public static IEnumerable AllFunctions(List declarations) { foreach (var d in declarations) { var cl = d as ClassDecl; if (cl != null) { foreach (var member in cl.Members) { var fn = member as Function; if (fn != null) { yield return fn; } } } } } /// /// Yields all functions and methods that are members of some class in the given list of /// declarations. /// Note, an iterator declaration is a class, in this sense. /// Note, if the given list are the top-level declarations of a module, the yield will include /// colemmas but not their associated prefix lemmas (which are tucked into the colemma's /// .PrefixLemma field). /// public static IEnumerable AllCallables(List declarations) { foreach (var d in declarations) { var cl = d as ClassDecl; if (cl != null) { foreach (var member in cl.Members) { var clbl = member as ICallable; if (clbl != null) { yield return clbl; } } } } } /// /// Yields all functions and methods that are members of some non-iterator class in the given /// list of declarations, as well as any IteratorDecl's in that list. /// public static IEnumerable AllItersAndCallables(List declarations) { foreach (var d in declarations) { if (d is IteratorDecl) { var iter = (IteratorDecl)d; yield return iter; } else if (d is ClassDecl) { var cl = (ClassDecl)d; foreach (var member in cl.Members) { var clbl = member as ICallable; if (clbl != null) { yield return clbl; } } } } } public static IEnumerable AllIteratorDecls(List declarations) { foreach (var d in declarations) { var iter = d as IteratorDecl; if (iter != null) { yield return iter; } } } public static IEnumerable AllCoLemmas(List declarations) { foreach (var d in declarations) { var cl = d as ClassDecl; if (cl != null) { foreach (var member in cl.Members) { var m = member as CoLemma; if (m != null) { yield return m; } } } } } } public class DefaultModuleDecl : ModuleDefinition { public DefaultModuleDecl() : base(Token.NoToken, "_module", false, false, null, null, null, true) { } public override bool IsDefaultModule { get { return true; } } } public abstract class TopLevelDecl : Declaration, TypeParameter.ParentType { public readonly ModuleDefinition Module; public readonly List TypeArgs; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(TypeArgs)); } public TopLevelDecl(IToken tok, string name, ModuleDefinition module, List typeArgs, Attributes attributes) : base(tok, name, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(typeArgs)); Module = module; TypeArgs = typeArgs; } public string FullName { get { return Module.Name + "." + Name; } } public string FullSanitizedName { get { return Module.CompileName + "." + CompileName; } } public string FullNameInContext(ModuleDefinition context) { if (Module == context) { return Name; } else { return Module.Name + "." + Name; } } public string FullCompileName { get { return Module.CompileName + ".@" + CompileName; } } } public class ClassDecl : TopLevelDecl { public readonly List Members; public bool HasConstructor; // filled in (early) during resolution; true iff there exists a member that is a Constructor [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(Members)); } public ClassDecl(IToken tok, string name, ModuleDefinition module, List typeArgs, [Captured] List members, Attributes attributes) : base(tok, name, module, typeArgs, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(module != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(members)); Members = members; } public virtual bool IsDefaultClass { get { return false; } } } public class DefaultClassDecl : ClassDecl { public DefaultClassDecl(ModuleDefinition module, [Captured] List members) : base(Token.NoToken, "_default", module, new List(), members, null) { Contract.Requires(module != null); Contract.Requires(cce.NonNullElements(members)); } public override bool IsDefaultClass { get { return true; } } } public class ArrayClassDecl : ClassDecl { public readonly int Dims; public ArrayClassDecl(int dims, ModuleDefinition module, Attributes attrs) : base(Token.NoToken, BuiltIns.ArrayClassName(dims), module, new List(new TypeParameter[]{new TypeParameter(Token.NoToken, "arg")}), new List(), attrs) { Contract.Requires(1 <= dims); Contract.Requires(module != null); Dims = dims; } } public abstract class DatatypeDecl : TopLevelDecl { public readonly List Ctors; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(Ctors)); Contract.Invariant(1 <= Ctors.Count); } public DatatypeDecl(IToken tok, string name, ModuleDefinition module, List typeArgs, [Captured] List ctors, Attributes attributes) : base(tok, name, module, typeArgs, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(module != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(ctors)); Contract.Requires(1 <= ctors.Count); Ctors = ctors; } public bool HasFinitePossibleValues { get { return (TypeArgs.Count == 0 && Ctors.TrueForAll(ctr => ctr.Formals.Count == 0)); } } } public class IndDatatypeDecl : DatatypeDecl { public DatatypeCtor DefaultCtor; // set during resolution public bool[] TypeParametersUsedInConstructionByDefaultCtor; // set during resolution; has same length as the number of type arguments public enum ES { NotYetComputed, Never, ConsultTypeArguments } public ES EqualitySupport = ES.NotYetComputed; public IndDatatypeDecl(IToken tok, string name, ModuleDefinition module, List typeArgs, [Captured] List ctors, Attributes attributes) : base(tok, name, module, typeArgs, ctors, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(module != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(ctors)); Contract.Requires(1 <= ctors.Count); } } public class TupleTypeDecl : IndDatatypeDecl { public readonly int Dims; /// /// Construct a resolved built-in tuple type with "dim" arguments. "systemModule" is expected to be the _System module. /// public TupleTypeDecl(int dims, ModuleDefinition systemModule) : this(systemModule, CreateTypeParameters(dims)) { Contract.Requires(0 <= dims); Contract.Requires(systemModule != null); } private TupleTypeDecl(ModuleDefinition systemModule, List typeArgs) : base(Token.NoToken, BuiltIns.TupleTypeName(typeArgs.Count), systemModule, typeArgs, CreateConstructors(typeArgs), null) { Contract.Requires(systemModule != null); Contract.Requires(typeArgs != null); Dims = typeArgs.Count; foreach (var ctor in Ctors) { ctor.EnclosingDatatype = this; // resolve here DefaultCtor = ctor; TypeParametersUsedInConstructionByDefaultCtor = new bool[typeArgs.Count]; for (int i = 0; i < typeArgs.Count; i++) { TypeParametersUsedInConstructionByDefaultCtor[i] = true; } } } private static List CreateTypeParameters(int dims) { Contract.Requires(0 <= dims); var ts = new List(); for (int i = 0; i < dims; i++) { ts.Add(new TypeParameter(Token.NoToken, "T" + i)); } return ts; } private static List CreateConstructors(List typeArgs) { Contract.Requires(typeArgs != null); var formals = new List(); for (int i = 0; i < typeArgs.Count; i++) { var tp = typeArgs[i]; var f = new Formal(Token.NoToken, i.ToString(), new UserDefinedType(Token.NoToken, tp.Name, tp), true, false); formals.Add(f); } var ctor = new DatatypeCtor(Token.NoToken, BuiltIns.TupleTypeCtorName, formals, null); return new List() { ctor }; } } public class CoDatatypeDecl : DatatypeDecl { public CoDatatypeDecl SscRepr; // filled in during resolution public CoDatatypeDecl(IToken tok, string name, ModuleDefinition module, List typeArgs, [Captured] List ctors, Attributes attributes) : base(tok, name, module, typeArgs, ctors, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(module != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(ctors)); Contract.Requires(1 <= ctors.Count); } } public class DatatypeCtor : Declaration, TypeParameter.ParentType { public readonly List Formals; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(Formals)); Contract.Invariant(Destructors != null); Contract.Invariant( Destructors.Count == 0 || // this is until resolution Destructors.Count == Formals.Count); // after resolution } // TODO: One could imagine having a precondition on datatype constructors public DatatypeDecl EnclosingDatatype; // filled in during resolution public SpecialField QueryField; // filled in during resolution public List Destructors = new List(); // contents filled in during resolution; includes both implicit (not mentionable in source) and explicit destructors public DatatypeCtor(IToken tok, string name, [Captured] List formals, Attributes attributes) : base(tok, name, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(formals)); this.Formals = formals; } public string FullName { get { Contract.Requires(EnclosingDatatype != null); Contract.Ensures(Contract.Result() != null); return "#" + EnclosingDatatype.FullName + "." + Name; } } } [ContractClass(typeof(UniqueNameGeneratorContracts))] public interface IUniqueNameGenerator { int GenerateId(string name); } [ContractClassFor(typeof(IUniqueNameGenerator))] public abstract class UniqueNameGeneratorContracts : IUniqueNameGenerator { public int GenerateId(string name) { Contract.Requires(name != null); throw new NotImplementedException(); } } /// /// An ICodeContext is a Function, Method, or IteratorDecl, or a NoContext. /// public interface ICodeContext { bool IsGhost { get; } bool IsStatic { get; } List TypeArgs { get; } List Ins { get ; } ModuleDefinition EnclosingModule { get; } // to be called only after signature-resolution is complete bool MustReverify { get; } string FullSanitizedName { get; } } /// /// An ICallable is a Function, Method, or IteratorDecl. /// public interface ICallable : ICodeContext { IToken Tok { get; } Specification Decreases { get; } /// /// The InferredDecreases property says whether or not a process was attempted to provide a default decreases /// clause. If such a process was attempted, even if the resulting decreases clause turned out to be empty, /// the property will get the value "true". This is so that a useful error message can be provided. /// bool InferredDecreases { get; set; } } /// /// An IMethodCodeContext is a Method or IteratorDecl. /// public interface IMethodCodeContext : ICallable { List Outs { get; } Specification Modifies { get; } } /// /// Applies when we are neither inside a method, nor iterator. /// public class NoContext : ICodeContext { public readonly ModuleDefinition Module; public NoContext(ModuleDefinition module) { this.Module = module; } bool ICodeContext.IsGhost { get { return true; } } bool ICodeContext.IsStatic { get { Contract.Assume(false, "should not be called on NoContext"); throw new cce.UnreachableException(); } } List ICodeContext.TypeArgs { get { return new List(); } } List ICodeContext.Ins { get { return new List(); } } Specification Decreases { get { return new Specification(null, null); } } ModuleDefinition ICodeContext.EnclosingModule { get { return Module; } } bool ICodeContext.MustReverify { get { Contract.Assume(false, "should not be called on NoContext"); throw new cce.UnreachableException(); } } public string FullSanitizedName { get { Contract.Assume(false, "should not be called on NoContext"); throw new cce.UnreachableException(); } } } public class IteratorDecl : ClassDecl, IMethodCodeContext { public readonly List Ins; public readonly List Outs; public readonly Specification Reads; public readonly Specification Modifies; public readonly Specification Decreases; public readonly List Requires; public readonly List Ensures; public readonly List YieldRequires; public readonly List YieldEnsures; public readonly BlockStmt Body; public bool SignatureIsOmitted { get { return SignatureEllipsis != null; } } public readonly IToken SignatureEllipsis; public readonly List OutsFields; public readonly List OutsHistoryFields; // these are the 'xs' variables public readonly List DecreasesFields; // filled in during resolution public SpecialField Member_Modifies; // filled in during resolution public SpecialField Member_Reads; // filled in during resolution public SpecialField Member_New; // filled in during resolution public Constructor Member_Init; // created during registration phase of resolution; its specification is filled in during resolution public Predicate Member_Valid; // created during registration phase of resolution; its specification is filled in during resolution public Method Member_MoveNext; // created during registration phase of resolution; its specification is filled in during resolution public readonly LocalVariable YieldCountVariable; public IteratorDecl(IToken tok, string name, ModuleDefinition module, List typeArgs, List ins, List outs, Specification reads, Specification mod, Specification decreases, List requires, List ensures, List yieldRequires, List yieldEnsures, BlockStmt body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, module, typeArgs, new List(), attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(module != null); Contract.Requires(typeArgs != null); Contract.Requires(ins != null); Contract.Requires(outs != null); Contract.Requires(reads != null); Contract.Requires(mod != null); Contract.Requires(decreases != null); Contract.Requires(requires != null); Contract.Requires(ensures != null); Contract.Requires(yieldRequires != null); Contract.Requires(yieldEnsures != null); Ins = ins; Outs = outs; Reads = reads; Modifies = mod; Decreases = decreases; Requires = requires; Ensures = ensures; YieldRequires = yieldRequires; YieldEnsures = yieldEnsures; Body = body; SignatureEllipsis = signatureEllipsis; OutsFields = new List(); OutsHistoryFields = new List(); DecreasesFields = new List(); YieldCountVariable = new LocalVariable(tok, tok, "_yieldCount", new EverIncreasingType(), true); YieldCountVariable.type = YieldCountVariable.OptionalType; // resolve YieldCountVariable here } /// /// This Dafny type exists only for the purpose of giving the yield-count variable a type, so /// that the type can be recognized during translation of Dafny into Boogie. It represents /// an integer component in a "decreases" clause whose order is (\lambda x,y :: x GREATER y), /// not the usual (\lambda x,y :: x LESS y AND 0 ATMOST y). /// public class EverIncreasingType : BasicType { [Pure] public override string TypeName(ModuleDefinition context) { return "_increasingInt"; } public override bool Equals(Type that) { return that.Normalize() is EverIncreasingType; } } bool ICodeContext.IsGhost { get { return false; } } bool ICodeContext.IsStatic { get { return true; } } List ICodeContext.TypeArgs { get { return this.TypeArgs; } } List ICodeContext.Ins { get { return this.Ins; } } List IMethodCodeContext.Outs { get { return this.Outs; } } Specification IMethodCodeContext.Modifies { get { return this.Modifies; } } IToken ICallable.Tok { get { return this.tok; } } Specification ICallable.Decreases { get { return this.Decreases; } } bool _inferredDecr; bool ICallable.InferredDecreases { set { _inferredDecr = value; } get { return _inferredDecr; } } ModuleDefinition ICodeContext.EnclosingModule { get { return this.Module; } } bool ICodeContext.MustReverify { get { return false; } } } public abstract class MemberDecl : Declaration { public readonly bool IsStatic; public readonly bool IsGhost; public TopLevelDecl EnclosingClass; // filled in during resolution public MemberDecl RefinementBase; // filled in during the pre-resolution refinement transformation; null if the member is new here public MemberDecl(IToken tok, string name, bool isStatic, bool isGhost, Attributes attributes) : base(tok, name, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); IsStatic = isStatic; IsGhost = isGhost; } /// /// Returns className+"."+memberName. Available only after resolution. /// public string FullName { get { Contract.Requires(EnclosingClass != null); Contract.Ensures(Contract.Result() != null); return EnclosingClass.FullName + "." + Name; } } public string FullSanitizedName { get { Contract.Requires(EnclosingClass != null); Contract.Ensures(Contract.Result() != null); return EnclosingClass.FullSanitizedName + "." + CompileName; } } public string FullNameInContext(ModuleDefinition context) { Contract.Requires(EnclosingClass != null); Contract.Ensures(Contract.Result() != null); return EnclosingClass.FullNameInContext(context) + "." + Name; } public override string CompileName { get { var nm = base.CompileName; if (this.Name == EnclosingClass.Name) { nm = "_" + nm; } return nm; } } public string FullCompileName { get { Contract.Requires(EnclosingClass != null); Contract.Ensures(Contract.Result() != null); return EnclosingClass.FullCompileName + ".@" + CompileName; } } } public class Field : MemberDecl { public readonly bool IsMutable; // says whether or not the field can ever change values public readonly bool IsUserMutable; // says whether or not code is allowed to assign to the field (IsUserMutable implies IsMutable) public readonly Type Type; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(Type != null); Contract.Invariant(!IsUserMutable || IsMutable); // IsUserMutable ==> IsMutable } public Field(IToken tok, string name, bool isGhost, Type type, Attributes attributes) : this(tok, name, isGhost, true, true, type, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(type != null); } public Field(IToken tok, string name, bool isGhost, bool isMutable, bool isUserMutable, Type type, Attributes attributes) : base(tok, name, false, isGhost, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(type != null); Contract.Requires(!isUserMutable || isMutable); IsMutable = isMutable; IsUserMutable = isUserMutable; Type = type; } } public class SpecialField : Field { public readonly string CompiledName; public readonly string PreString; public readonly string PostString; public SpecialField(IToken tok, string name, string compiledName, string preString, string postString, bool isGhost, bool isMutable, bool isUserMutable, Type type, Attributes attributes) : base(tok, name, isGhost, isMutable, isUserMutable, type, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(compiledName != null); Contract.Requires(preString != null); Contract.Requires(postString != null); Contract.Requires(!isUserMutable || isMutable); Contract.Requires(type != null); CompiledName = compiledName; PreString = preString; PostString = postString; } } public class DatatypeDestructor : SpecialField { public readonly DatatypeCtor EnclosingCtor; public readonly Formal CorrespondingFormal; public DatatypeDestructor(IToken tok, DatatypeCtor enclosingCtor, Formal correspondingFormal, string name, string compiledName, string preString, string postString, bool isGhost, Type type, Attributes attributes) : base(tok, name, compiledName, preString, postString, isGhost, false, false, type, attributes) { Contract.Requires(tok != null); Contract.Requires(enclosingCtor != null); Contract.Requires(correspondingFormal != null); Contract.Requires(name != null); Contract.Requires(compiledName != null); Contract.Requires(preString != null); Contract.Requires(postString != null); Contract.Requires(type != null); EnclosingCtor = enclosingCtor; CorrespondingFormal = correspondingFormal; } } public class ArbitraryTypeDecl : TopLevelDecl, TypeParameter.ParentType { public readonly TypeParameter TheType; public TypeParameter.EqualitySupportValue EqualitySupport { get { return TheType.EqualitySupport; } } public bool MustSupportEquality { get { return TheType.MustSupportEquality; } } [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(TheType != null && Name == TheType.Name); } public ArbitraryTypeDecl(IToken tok, string name, ModuleDefinition module, TypeParameter.EqualitySupportValue equalitySupport, Attributes attributes) : base(tok, name, module, new List(), attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(module != null); TheType = new TypeParameter(tok, name, equalitySupport); } } [ContractClass(typeof(IVariableContracts))] public interface IVariable { string Name { get; } string DisplayName { // what the user thinks he wrote get; } string UniqueName { get; } bool HasBeenAssignedUniqueName { // unique names are not assigned until the Translator; if you don't already know if that stage has run, this boolean method will tell you get; } string AssignUniqueName(IUniqueNameGenerator generator); string CompileName { get; } Type Type { get; } bool IsMutable { get; } bool IsGhost { get; } IToken Tok { get; } } [ContractClassFor(typeof(IVariable))] public abstract class IVariableContracts : IVariable { public string Name { get { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); // this getter implementation is here only so that the Ensures contract can be given here } } public string DisplayName { get { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); // this getter implementation is here only so that the Ensures contract can be given here } } public string UniqueName { get { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); // this getter implementation is here only so that the Ensures contract can be given here } } public bool HasBeenAssignedUniqueName { get { throw new NotImplementedException(); // this getter implementation is here only so that the Ensures contract can be given here } } public string CompileName { get { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); // this getter implementation is here only so that the Ensures contract can be given here } } public Type Type { get { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); // this getter implementation is here only so that the Ensures contract can be given here } } public bool IsMutable { get { throw new NotImplementedException(); } } public bool IsGhost { get { throw new NotImplementedException(); } } public IToken Tok { get { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); } } public string AssignUniqueName(IUniqueNameGenerator generator) { Contract.Ensures(Contract.Result() != null); throw new NotImplementedException(); } } public abstract class NonglobalVariable : IVariable { public readonly IToken tok; readonly string name; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(tok != null); Contract.Invariant(name != null); Contract.Invariant(type != null); } public string Name { get { Contract.Ensures(Contract.Result() != null); return name; } } public string DisplayName { get { return LocalVariable.DisplayNameHelper(this); } } private string uniqueName; public string UniqueName { get { return uniqueName; } } public bool HasBeenAssignedUniqueName { get { return uniqueName != null; } } public string AssignUniqueName(IUniqueNameGenerator generator) { if (uniqueName == null) { var uniqueId = generator.GenerateId(Name); uniqueName = string.Format("{0}#{1}", Name, uniqueId); compileName = string.Format("_{0}_{1}", uniqueId, CompilerizeName(name)); } return UniqueName; } static char[] specialChars = new char[] { '\'', '_', '?', '\\', '#' }; public static string CompilerizeName(string nm) { if ('0' <= nm[0] && nm[0] <= '9') { // the identifier is one that consists of just digits return "_" + nm; } string name = null; int i = 0; while (true) { int j = nm.IndexOfAny(specialChars, i); if (j == -1) { if (i == 0) { return nm; // this is the common case } else { return name + nm.Substring(i); } } else { string nxt = nm.Substring(i, j - i); name = name == null ? nxt : name + nxt; switch (nm[j]) { case '\'': name += "_k"; break; case '_': name += "__"; break; case '?': name += "_q"; break; case '\\': name += "_b"; break; case '#': name += "_h"; break; default: Contract.Assume(false); // unexpected character break; } i = j + 1; if (i == nm.Length) { return name; } } } } protected string compileName; public virtual string CompileName { get { if (compileName == null) { compileName = string.Format("_{0}_{1}", Compiler.UniqueNameGeneratorSingleton.GenerateId(Name), CompilerizeName(name)); } return compileName; } } Type type; //[Pure(false)] // TODO: if Type gets the status of [Frozen], then this attribute is not needed public Type Type { get { Contract.Ensures(Contract.Result() != null); return type.Normalize(); } } public abstract bool IsMutable { get; } bool isGhost; // readonly after resolution public bool IsGhost { get { return isGhost; } set { isGhost = value; } } public IToken Tok { get { return tok; } } public NonglobalVariable(IToken tok, string name, Type type, bool isGhost) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(type != null); this.tok = tok; this.name = name; this.type = type; this.isGhost = isGhost; } } public class Formal : NonglobalVariable { public readonly bool InParam; // true to in-parameter, false for out-parameter public override bool IsMutable { get { return !InParam; } } public Formal(IToken tok, string name, Type type, bool inParam, bool isGhost) : base(tok, name, type, isGhost) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(type != null); InParam = inParam; } public bool HasName { get { return !Name.StartsWith("#"); } } public override string CompileName { get { if (compileName == null) { compileName = CompilerizeName(Name); } return compileName; } } } /// /// An ImplicitFormal is a parameter that is declared implicitly, in particular the "_k" depth parameter /// of each colemma (for use in the comethod body only, not the specification). /// public class ImplicitFormal : Formal { public ImplicitFormal(IToken tok, string name, Type type, bool inParam, bool isGhost) : base(tok, name, type, inParam, isGhost) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(type != null); } } /// /// A "ThisSurrogate" is used during translation time to make the treatment of the receiver more similar to /// the treatment of other in-parameters. /// public class ThisSurrogate : Formal { public ThisSurrogate(IToken tok, Type type) : base(tok, "this", type, true, false) { Contract.Requires(tok != null); Contract.Requires(type != null); } } public class BoundVar : NonglobalVariable { public override bool IsMutable { get { return false; } } public BoundVar(IToken tok, string name, Type type) : base(tok, name, type, false) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(type != null); } } public class Function : MemberDecl, TypeParameter.ParentType, ICallable { public bool IsRecursive; // filled in during resolution public readonly List TypeArgs; public readonly IToken OpenParen; // can be null (for predicates), if there are no formals public readonly List Formals; public readonly Type ResultType; public readonly List Req; public readonly List Reads; public readonly List Ens; public readonly Specification Decreases; public Expression Body; // an extended expression; Body is readonly after construction, except for any kind of rewrite that may take place around the time of resolution public bool SignatureIsOmitted { get { return SignatureEllipsis != null; } } // is "false" for all Function objects that survive into resolution public readonly IToken SignatureEllipsis; public bool IsBuiltin; /// /// The "AllCalls" field is used for non-CoPredicate, non-PrefixPredicate functions only (so its value should not be relied upon for CoPredicate and PrefixPredicate functions). /// It records all function calls made by the Function, including calls made in the body as well as in the specification. /// The field is filled in during resolution (and used toward the end of resolution, to attach a helpful "decreases" prefix to functions in clusters /// with co-recursive calls. /// public readonly List AllCalls = new List(); public enum CoCallClusterInvolvement { None, // the SCC containing the function does not involve any co-recursive calls IsMutuallyRecursiveTarget, // the SCC contains co-recursive calls, and this function is the target of some non-self recursive call CoRecursiveTargetAllTheWay, // the SCC contains co-recursive calls, and this function is the target only of self-recursive calls and co-recursive calls } public CoCallClusterInvolvement CoClusterTarget = CoCallClusterInvolvement.None; [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(TypeArgs)); Contract.Invariant(cce.NonNullElements(Formals)); Contract.Invariant(ResultType != null); Contract.Invariant(cce.NonNullElements(Req)); Contract.Invariant(cce.NonNullElements(Reads)); Contract.Invariant(cce.NonNullElements(Ens)); Contract.Invariant(Decreases != null); } /// /// Note, functions are "ghost" by default; a non-ghost function is called a "function method". /// public Function(IToken tok, string name, bool isStatic, bool isGhost, List typeArgs, IToken openParen, List formals, Type resultType, List req, List reads, List ens, Specification decreases, Expression body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, isStatic, isGhost, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(formals)); Contract.Requires(resultType != null); Contract.Requires(cce.NonNullElements(req)); Contract.Requires(cce.NonNullElements(reads)); Contract.Requires(cce.NonNullElements(ens)); Contract.Requires(decreases != null); this.TypeArgs = typeArgs; this.OpenParen = openParen; this.Formals = formals; this.ResultType = resultType; this.Req = req; this.Reads = reads; this.Ens = ens; this.Decreases = decreases; this.Body = body; this.SignatureEllipsis = signatureEllipsis; } bool ICodeContext.IsGhost { get { return this.IsGhost; } } bool ICodeContext.IsStatic { get { return this.IsStatic; } } List ICodeContext.TypeArgs { get { return this.TypeArgs; } } List ICodeContext.Ins { get { return this.Formals; } } IToken ICallable.Tok { get { return this.tok; } } Specification ICallable.Decreases { get { return this.Decreases; } } bool _inferredDecr; bool ICallable.InferredDecreases { set { _inferredDecr = value; } get { return _inferredDecr; } } ModuleDefinition ICodeContext.EnclosingModule { get { return this.EnclosingClass.Module; } } bool ICodeContext.MustReverify { get { return false; } } } public class Predicate : Function { public enum BodyOriginKind { OriginalOrInherited, // this predicate definition is new (and the predicate may or may not have a body), or the predicate's body (whether or not it exists) is being inherited unmodified (from the previous refinement--it may be that the inherited body was itself an extension, for example) DelayedDefinition, // this predicate declaration provides, for the first time, a body--the declaration refines a previously declared predicate, but the previous one had no body Extension // this predicate extends the definition of a predicate with a body in a module being refined } public readonly BodyOriginKind BodyOrigin; public Predicate(IToken tok, string name, bool isStatic, bool isGhost, List typeArgs, IToken openParen, List formals, List req, List reads, List ens, Specification decreases, Expression body, BodyOriginKind bodyOrigin, Attributes attributes, IToken signatureEllipsis) : base(tok, name, isStatic, isGhost, typeArgs, openParen, formals, new BoolType(), req, reads, ens, decreases, body, attributes, signatureEllipsis) { Contract.Requires(bodyOrigin == Predicate.BodyOriginKind.OriginalOrInherited || body != null); BodyOrigin = bodyOrigin; } } /// /// An PrefixPredicate is the inductive unrolling P# implicitly declared for every copredicate P. /// public class PrefixPredicate : Function { public readonly Formal K; public readonly CoPredicate Co; public PrefixPredicate(IToken tok, string name, bool isStatic, List typeArgs, IToken openParen, Formal k, List formals, List req, List reads, List ens, Specification decreases, Expression body, Attributes attributes, CoPredicate coPred) : base(tok, name, isStatic, true, typeArgs, openParen, formals, new BoolType(), req, reads, ens, decreases, body, attributes, null) { Contract.Requires(k != null); Contract.Requires(coPred != null); Contract.Requires(formals != null && 1 <= formals.Count && formals[0] == k); K = k; Co = coPred; } } public class CoPredicate : Function { public readonly List Uses = new List(); // filled in during resolution, used by verifier public PrefixPredicate PrefixPredicate; // filled in during resolution (name registration) public CoPredicate(IToken tok, string name, bool isStatic, List typeArgs, IToken openParen, List formals, List req, List reads, List ens, Expression body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, isStatic, true, typeArgs, openParen, formals, new BoolType(), req, reads, ens, new Specification(new List(), null), body, attributes, signatureEllipsis) { } /// /// For the given call P(s), return P#[depth](s). The resulting expression shares some of the subexpressions /// with 'fexp' (that is, what is returned is not necessarily a clone). /// public FunctionCallExpr CreatePrefixPredicateCall(FunctionCallExpr fexp, Expression depth) { Contract.Requires(fexp != null); Contract.Requires(fexp.Function == this); Contract.Requires(depth != null); Contract.Ensures(Contract.Result() != null); var args = new List() { depth }; args.AddRange(fexp.Args); var prefixPredCall = new FunctionCallExpr(fexp.tok, this.PrefixPredicate.Name, fexp.Receiver, fexp.OpenParen, args); prefixPredCall.Function = this.PrefixPredicate; // resolve here prefixPredCall.TypeArgumentSubstitutions = fexp.TypeArgumentSubstitutions; // resolve here prefixPredCall.Type = fexp.Type; // resolve here prefixPredCall.CoCall = fexp.CoCall; // resolve here return prefixPredCall; } } public class Method : MemberDecl, TypeParameter.ParentType, IMethodCodeContext { public bool SignatureIsOmitted { get { return SignatureEllipsis != null; } } public readonly IToken SignatureEllipsis; public bool MustReverify; public readonly List TypeArgs; public readonly List Ins; public readonly List Outs; public readonly List Req; public readonly Specification Mod; public readonly List Ens; public readonly Specification Decreases; public BlockStmt Body; // Body is readonly after construction, except for any kind of rewrite that may take place around the time of resolution public bool IsRecursive; // filled in during resolution public bool IsTailRecursive; // filled in during resolution public readonly ISet AssignedAssumptionVariables = new HashSet(); [ContractInvariantMethod] void ObjectInvariant() { Contract.Invariant(cce.NonNullElements(TypeArgs)); Contract.Invariant(cce.NonNullElements(Ins)); Contract.Invariant(cce.NonNullElements(Outs)); Contract.Invariant(cce.NonNullElements(Req)); Contract.Invariant(Mod != null); Contract.Invariant(cce.NonNullElements(Ens)); Contract.Invariant(Decreases != null); } public Method(IToken tok, string name, bool isStatic, bool isGhost, [Captured] List typeArgs, [Captured] List ins, [Captured] List outs, [Captured] List req, [Captured] Specification mod, [Captured] List ens, [Captured] Specification decreases, [Captured] BlockStmt body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, isStatic, isGhost, attributes) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(ins)); Contract.Requires(cce.NonNullElements(outs)); Contract.Requires(cce.NonNullElements(req)); Contract.Requires(mod != null); Contract.Requires(cce.NonNullElements(ens)); Contract.Requires(decreases != null); this.TypeArgs = typeArgs; this.Ins = ins; this.Outs = outs; this.Req = req; this.Mod = mod; this.Ens = ens; this.Decreases = decreases; this.Body = body; this.SignatureEllipsis = signatureEllipsis; MustReverify = false; } bool ICodeContext.IsGhost { get { return this.IsGhost; } } bool ICodeContext.IsStatic { get { return this.IsStatic; } } List ICodeContext.TypeArgs { get { return this.TypeArgs; } } List ICodeContext.Ins { get { return this.Ins; } } List IMethodCodeContext.Outs { get { return this.Outs; } } Specification IMethodCodeContext.Modifies { get { return Mod; } } IToken ICallable.Tok { get { return this.tok; } } Specification ICallable.Decreases { get { return this.Decreases; } } bool _inferredDecr; bool ICallable.InferredDecreases { set { _inferredDecr = value; } get { return _inferredDecr; } } ModuleDefinition ICodeContext.EnclosingModule { get { Contract.Assert(this.EnclosingClass != null); // this getter is supposed to be called only after signature-resolution is complete return this.EnclosingClass.Module; } } bool ICodeContext.MustReverify { get { return this.MustReverify; } } } public class Lemma : Method { public Lemma(IToken tok, string name, bool isStatic, [Captured] List typeArgs, [Captured] List ins, [Captured] List outs, [Captured] List req, [Captured] Specification mod, [Captured] List ens, [Captured] Specification decreases, [Captured] BlockStmt body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, isStatic, true, typeArgs, ins, outs, req, mod, ens, decreases, body, attributes, signatureEllipsis) { } } public class Constructor : Method { public Constructor(IToken tok, string name, [Captured] List typeArgs, [Captured] List ins, [Captured] List req, [Captured] Specification mod, [Captured] List ens, [Captured] Specification decreases, [Captured] BlockStmt body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, false, false, typeArgs, ins, new List(), req, mod, ens, decreases, body, attributes, signatureEllipsis) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(ins)); Contract.Requires(cce.NonNullElements(req)); Contract.Requires(mod != null); Contract.Requires(cce.NonNullElements(ens)); Contract.Requires(decreases != null); } public bool HasName { get { return Name != "_ctor"; } } } /// /// A PrefixLemma is the inductive unrolling M# implicitly declared for every colemma M. /// public class PrefixLemma : Method { public readonly Formal K; public readonly CoLemma Co; public PrefixLemma(IToken tok, string name, bool isStatic, List typeArgs, Formal k, List ins, List outs, List req, Specification mod, List ens, Specification decreases, BlockStmt body, Attributes attributes, CoLemma co) : base(tok, name, isStatic, true, typeArgs, ins, outs, req, mod, ens, decreases, body, attributes, null) { Contract.Requires(k != null); Contract.Requires(ins != null && 1 <= ins.Count && ins[0] == k); Contract.Requires(co != null); K = k; Co = co; } } public class CoLemma : Method { public PrefixLemma PrefixLemma; // filled in during resolution (name registration) public CoLemma(IToken tok, string name, bool isStatic, List typeArgs, List ins, [Captured] List outs, List req, [Captured] Specification mod, List ens, Specification decreases, BlockStmt body, Attributes attributes, IToken signatureEllipsis) : base(tok, name, isStatic, true, typeArgs, ins, outs, req, mod, ens, decreases, body, attributes, signatureEllipsis) { Contract.Requires(tok != null); Contract.Requires(name != null); Contract.Requires(cce.NonNullElements(typeArgs)); Contract.Requires(cce.NonNullElements(ins)); Contract.Requires(cce.NonNullElements(outs)); Contract.Requires(cce.NonNullElements(req)); Contract.Requires(mod != null); Contract.Requires(cce.NonNullElements(ens)); Contract.Requires(decreases != null); } } // ------------------------------------------------------------------------------------------------------ public abstract class Statement { public readonly IToken Tok; public readonly IToken EndTok; // typically a terminating semi-colon or end-curly-brace public LList